From ef1f716f943660b6abb1aa27f8b796abfe495aad Mon Sep 17 00:00:00 2001 From: "ci.datadog-api-spec" Date: Wed, 2 Sep 2026 20:37:42 +0000 Subject: [PATCH] Regenerate client from commit 3513039 of spec repo --- hugo/config/_default/menus/api.en.yaml | 65 ++ .../create-a-unit-cost/index.md | 3 + .../delete-a-unit-cost/index.md | 3 + .../get-a-unit-cost/index.md | 3 + .../list-unit-costs/index.md | 3 + .../update-a-unit-cost/index.md | 3 + .../en/api/v2/aws-integration/examples.json | 20 +- .../v2/cloud-cost-management/examples.json | 547 +++++++++++++++ .../v2/logs-custom-destinations/examples.json | 8 +- .../en/api/v2/okta-integration/examples.json | 16 +- .../api/v2/workflow-automation/examples.json | 24 +- hugo/data/api/v2/full_spec.yaml | 654 ++++++++++++++++++ hugo/data/api/v2/translate_actions.json | 24 + 13 files changed, 1327 insertions(+), 46 deletions(-) create mode 100644 hugo/content/en/api/latest/cloud-cost-management/create-a-unit-cost/index.md create mode 100644 hugo/content/en/api/latest/cloud-cost-management/delete-a-unit-cost/index.md create mode 100644 hugo/content/en/api/latest/cloud-cost-management/get-a-unit-cost/index.md create mode 100644 hugo/content/en/api/latest/cloud-cost-management/list-unit-costs/index.md create mode 100644 hugo/content/en/api/latest/cloud-cost-management/update-a-unit-cost/index.md diff --git a/hugo/config/_default/menus/api.en.yaml b/hugo/config/_default/menus/api.en.yaml index d86e3b6447c..11532e2433a 100644 --- a/hugo/config/_default/menus/api.en.yaml +++ b/hugo/config/_default/menus/api.en.yaml @@ -11236,6 +11236,71 @@ menu: - ListTagPipelinesRulesets unstable: [] order: 16 + - name: Update a unit cost + url: /api/latest/cloud-cost-management/update-a-unit-cost/ + identifier: cloud-cost-management-update-a-unit-cost + parent: cloud-cost-management + generated: true + params: + versions: + - v2 + operationids: + - UpdateUnitCost + unstable: + - v2 + order: 75 + - name: Get a unit cost + url: /api/latest/cloud-cost-management/get-a-unit-cost/ + identifier: cloud-cost-management-get-a-unit-cost + parent: cloud-cost-management + generated: true + params: + versions: + - v2 + operationids: + - GetUnitCost + unstable: + - v2 + order: 74 + - name: Delete a unit cost + url: /api/latest/cloud-cost-management/delete-a-unit-cost/ + identifier: cloud-cost-management-delete-a-unit-cost + parent: cloud-cost-management + generated: true + params: + versions: + - v2 + operationids: + - DeleteUnitCost + unstable: + - v2 + order: 76 + - name: Create a unit cost + url: /api/latest/cloud-cost-management/create-a-unit-cost/ + identifier: cloud-cost-management-create-a-unit-cost + parent: cloud-cost-management + generated: true + params: + versions: + - v2 + operationids: + - CreateUnitCost + unstable: + - v2 + order: 73 + - name: List unit costs + url: /api/latest/cloud-cost-management/list-unit-costs/ + identifier: cloud-cost-management-list-unit-costs + parent: cloud-cost-management + generated: true + params: + versions: + - v2 + operationids: + - ListUnitCosts + unstable: + - v2 + order: 72 - name: List Cloud Cost Management tags url: /api/latest/cloud-cost-management/list-cloud-cost-management-tags/ identifier: cloud-cost-management-list-cloud-cost-management-tags diff --git a/hugo/content/en/api/latest/cloud-cost-management/create-a-unit-cost/index.md b/hugo/content/en/api/latest/cloud-cost-management/create-a-unit-cost/index.md new file mode 100644 index 00000000000..eaa32f6988e --- /dev/null +++ b/hugo/content/en/api/latest/cloud-cost-management/create-a-unit-cost/index.md @@ -0,0 +1,3 @@ +--- +title: Create a unit cost +--- diff --git a/hugo/content/en/api/latest/cloud-cost-management/delete-a-unit-cost/index.md b/hugo/content/en/api/latest/cloud-cost-management/delete-a-unit-cost/index.md new file mode 100644 index 00000000000..7270c7a5b29 --- /dev/null +++ b/hugo/content/en/api/latest/cloud-cost-management/delete-a-unit-cost/index.md @@ -0,0 +1,3 @@ +--- +title: Delete a unit cost +--- diff --git a/hugo/content/en/api/latest/cloud-cost-management/get-a-unit-cost/index.md b/hugo/content/en/api/latest/cloud-cost-management/get-a-unit-cost/index.md new file mode 100644 index 00000000000..eb3f1f31caf --- /dev/null +++ b/hugo/content/en/api/latest/cloud-cost-management/get-a-unit-cost/index.md @@ -0,0 +1,3 @@ +--- +title: Get a unit cost +--- diff --git a/hugo/content/en/api/latest/cloud-cost-management/list-unit-costs/index.md b/hugo/content/en/api/latest/cloud-cost-management/list-unit-costs/index.md new file mode 100644 index 00000000000..35c7fb49542 --- /dev/null +++ b/hugo/content/en/api/latest/cloud-cost-management/list-unit-costs/index.md @@ -0,0 +1,3 @@ +--- +title: List unit costs +--- diff --git a/hugo/content/en/api/latest/cloud-cost-management/update-a-unit-cost/index.md b/hugo/content/en/api/latest/cloud-cost-management/update-a-unit-cost/index.md new file mode 100644 index 00000000000..ab11db86b2b --- /dev/null +++ b/hugo/content/en/api/latest/cloud-cost-management/update-a-unit-cost/index.md @@ -0,0 +1,3 @@ +--- +title: Update a unit cost +--- diff --git a/hugo/content/en/api/v2/aws-integration/examples.json b/hugo/content/en/api/v2/aws-integration/examples.json index 8be06bd3929..cbac808190c 100644 --- a/hugo/content/en/api/v2/aws-integration/examples.json +++ b/hugo/content/en/api/v2/aws-integration/examples.json @@ -10,8 +10,7 @@ "env:prod" ], "auth_config": { - "access_key_id": "AKIAIOSFODNN7EXAMPLE", - "secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY" + "access_key_id": "AKIAIOSFODNN7EXAMPLE" }, "aws_account_id": "123456789012", "aws_partition": "aws", @@ -84,7 +83,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

List of AWS Account Integration Configs.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

AWS Account response attributes.

\n
\n
\n
\n
\n
\n

account_tags

\n
\n

[string]

\n

Tags to apply to all hosts and metrics reporting for this account. Defaults to [].

\n
\n \n
\n
\n
\n
\n
\n

auth_config

\n
\n

 <oneOf>

\n

AWS Authentication config.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

AWS Authentication config to integrate your account using an access key pair.

\n
\n
\n
\n
\n
\n

access_key_id [required]

\n
\n

string

\n

AWS Access Key ID.

\n
\n \n
\n
\n
\n
\n
\n

secret_access_key

\n
\n

string

\n

AWS Secret Access Key.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

AWS Authentication config to integrate your account using an IAM role.

\n
\n
\n
\n
\n
\n

external_id

\n
\n

string

\n

AWS IAM External ID for associated role.

\n
\n \n
\n
\n
\n
\n
\n

role_name [required]

\n
\n

string

\n

AWS IAM Role name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

aws_account_id [required]

\n
\n

string

\n

AWS Account ID.

\n
\n \n
\n
\n
\n
\n
\n

aws_partition

\n
\n

enum

\n

AWS partition your AWS account is scoped to. Defaults to aws.\nSee Partitions\nin the AWS documentation for more information. \nAllowed enum values: aws,aws-cn,aws-us-gov

\n
\n \n
\n
\n
\n
\n
\n

aws_regions

\n
\n

 <oneOf>

\n

AWS Regions to collect data from. Defaults to include_all.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

Include all regions. Defaults to true.

\n
\n
\n
\n
\n
\n

include_all [required]

\n
\n

boolean

\n

Include all regions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Include only these regions.

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these regions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the account integration was created.

\n
\n \n
\n
\n
\n
\n
\n

logs_config

\n
\n

object

\n

AWS Logs Collection config.

\n
\n
\n
\n
\n
\n

lambda_forwarder

\n
\n

object

\n

Log Autosubscription configuration for Datadog Forwarder Lambda functions.\nAutomatically set up triggers for existing and new logs for some services,\nensuring no logs from new resources are missed and saving time spent on manual configuration.

\n
\n
\n
\n
\n
\n

lambdas

\n
\n

[string]

\n

List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to [].

\n
\n \n
\n
\n
\n
\n
\n

log_source_config

\n
\n

object

\n

Log source configuration.

\n
\n
\n
\n
\n
\n

tag_filters

\n
\n

[object]

\n

List of AWS log source tag filters. Defaults to [].

\n
\n
\n
\n
\n
\n

source

\n
\n

string

\n

The AWS log source to which the tag filters defined in tags are applied.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

The AWS resource tags to filter on for the log source specified by source.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

sources

\n
\n

[string]

\n

List of service IDs set to enable automatic log collection.\nDiscover the list of available services with the\nGet list of AWS log ready\nservices\nendpoint.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

metrics_config

\n
\n

object

\n

AWS Metrics Collection config.

\n
\n
\n
\n
\n
\n

automute_enabled

\n
\n

boolean

\n

Enable EC2 automute for AWS metrics. Defaults to true.

\n
\n \n
\n
\n
\n
\n
\n

collect_cloudwatch_alarms

\n
\n

boolean

\n

Enable CloudWatch alarms collection. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

collect_custom_metrics

\n
\n

boolean

\n

Enable custom metrics collection. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Enable AWS metrics collection. Defaults to true.

\n
\n \n
\n
\n
\n
\n
\n

metric_name_filters

\n
\n

[ <oneOf>]

\n

AWS CloudWatch metric name filters. Each filter applies to a single namespace.\nExactly one of include_only or exclude_only must be set on each filter.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

Include only metric names matching one of these patterns for a single namespace.

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only metric names matching one of these patterns.

\n
\n \n
\n
\n
\n
\n
\n

namespace [required]

\n
\n

string

\n

The AWS CloudWatch namespace to which this metric name filter applies.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Exclude metric names matching one of these patterns for a single namespace.

\n
\n
\n
\n
\n
\n

exclude_only [required]

\n
\n

[string]

\n

Exclude metric names matching one of these patterns.

\n
\n \n
\n
\n
\n
\n
\n

namespace [required]

\n
\n

string

\n

The AWS CloudWatch namespace to which this metric name filter applies.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

namespace_filters

\n
\n

 <oneOf>

\n

AWS Metrics namespace filters. Defaults to exclude_only.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

Exclude only these namespaces from metrics collection.\nDefaults to ["AWS/SQS", "AWS/ElasticMapReduce", "AWS/Usage"].\nAWS/SQS, AWS/ElasticMapReduce, and AWS/Usage are excluded by default\nto reduce your AWS CloudWatch costs from GetMetricData API calls.

\n
\n
\n
\n
\n
\n

exclude_only [required]

\n
\n

[string]

\n

Exclude only these namespaces from metrics collection.\nDefaults to ["AWS/SQS", "AWS/ElasticMapReduce", "AWS/Usage"].\nAWS/SQS, AWS/ElasticMapReduce, and AWS/Usage are excluded by default\nto reduce your AWS CloudWatch costs from GetMetricData API calls.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Include only these namespaces.

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these namespaces.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tag_filters

\n
\n

[object]

\n

AWS Metrics collection tag filters list. Defaults to [].

\n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

The AWS service for which the tag filters defined in tags will be applied.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

The AWS resource tags to filter on for the service specified by namespace.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the account integration was updated.

\n
\n \n
\n
\n
\n
\n
\n

resources_config

\n
\n

object

\n

AWS Resources Collection config.

\n
\n
\n
\n
\n
\n

cloud_security_posture_management_collection

\n
\n

boolean

\n

Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations,\nidentity risks, and compliance violations. Defaults to false.\nRequires extended_collection to be set to true.

\n
\n \n
\n
\n
\n
\n
\n

extended_collection

\n
\n

boolean

\n

Whether Datadog collects additional attributes and configuration information about the resources\nin your AWS account. Defaults to true. Required for cloud_security_posture_management_collection.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

traces_config

\n
\n

object

\n

AWS Traces Collection config.

\n
\n
\n
\n
\n
\n

xray_services

\n
\n

 <oneOf>

\n

AWS X-Ray services to collect traces from. Defaults to include_only.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

Include all services.

\n
\n
\n
\n
\n
\n

include_all [required]

\n
\n

boolean

\n

Include all services.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Include only these services. Defaults to [].

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these services.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Unique Datadog ID of the AWS Account Integration Config.\nTo get the config ID for an account, use the\nList all AWS integrations\nendpoint and query by AWS Account ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

AWS Account resource type. \nAllowed enum values: account

default: account

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

List of AWS Account Integration Configs.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

AWS Account response attributes.

\n
\n
\n
\n
\n
\n

account_tags

\n
\n

[string]

\n

Tags to apply to all hosts and metrics reporting for this account. Defaults to [].

\n
\n \n
\n
\n
\n
\n
\n

auth_config

\n
\n

 <oneOf>

\n

AWS Authentication config.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

AWS Authentication config to integrate your account using an access key pair.

\n
\n
\n
\n
\n
\n

access_key_id [required]

\n
\n

string

\n

AWS Access Key ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

AWS Authentication config to integrate your account using an IAM role.

\n
\n
\n
\n
\n
\n

external_id

\n
\n

string

\n

AWS IAM External ID for associated role.

\n
\n \n
\n
\n
\n
\n
\n

role_name [required]

\n
\n

string

\n

AWS IAM Role name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

aws_account_id [required]

\n
\n

string

\n

AWS Account ID.

\n
\n \n
\n
\n
\n
\n
\n

aws_partition

\n
\n

enum

\n

AWS partition your AWS account is scoped to. Defaults to aws.\nSee Partitions\nin the AWS documentation for more information. \nAllowed enum values: aws,aws-cn,aws-us-gov

\n
\n \n
\n
\n
\n
\n
\n

aws_regions

\n
\n

 <oneOf>

\n

AWS Regions to collect data from. Defaults to include_all.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

Include all regions. Defaults to true.

\n
\n
\n
\n
\n
\n

include_all [required]

\n
\n

boolean

\n

Include all regions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Include only these regions.

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these regions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the account integration was created.

\n
\n \n
\n
\n
\n
\n
\n

logs_config

\n
\n

object

\n

AWS Logs Collection config.

\n
\n
\n
\n
\n
\n

lambda_forwarder

\n
\n

object

\n

Log Autosubscription configuration for Datadog Forwarder Lambda functions.\nAutomatically set up triggers for existing and new logs for some services,\nensuring no logs from new resources are missed and saving time spent on manual configuration.

\n
\n
\n
\n
\n
\n

lambdas

\n
\n

[string]

\n

List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to [].

\n
\n \n
\n
\n
\n
\n
\n

log_source_config

\n
\n

object

\n

Log source configuration.

\n
\n
\n
\n
\n
\n

tag_filters

\n
\n

[object]

\n

List of AWS log source tag filters. Defaults to [].

\n
\n
\n
\n
\n
\n

source

\n
\n

string

\n

The AWS log source to which the tag filters defined in tags are applied.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

The AWS resource tags to filter on for the log source specified by source.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

sources

\n
\n

[string]

\n

List of service IDs set to enable automatic log collection.\nDiscover the list of available services with the\nGet list of AWS log ready\nservices\nendpoint.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

metrics_config

\n
\n

object

\n

AWS Metrics Collection config.

\n
\n
\n
\n
\n
\n

automute_enabled

\n
\n

boolean

\n

Enable EC2 automute for AWS metrics. Defaults to true.

\n
\n \n
\n
\n
\n
\n
\n

collect_cloudwatch_alarms

\n
\n

boolean

\n

Enable CloudWatch alarms collection. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

collect_custom_metrics

\n
\n

boolean

\n

Enable custom metrics collection. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Enable AWS metrics collection. Defaults to true.

\n
\n \n
\n
\n
\n
\n
\n

metric_name_filters

\n
\n

[ <oneOf>]

\n

AWS CloudWatch metric name filters. Each filter applies to a single namespace.\nExactly one of include_only or exclude_only must be set on each filter.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

Include only metric names matching one of these patterns for a single namespace.

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only metric names matching one of these patterns.

\n
\n \n
\n
\n
\n
\n
\n

namespace [required]

\n
\n

string

\n

The AWS CloudWatch namespace to which this metric name filter applies.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Exclude metric names matching one of these patterns for a single namespace.

\n
\n
\n
\n
\n
\n

exclude_only [required]

\n
\n

[string]

\n

Exclude metric names matching one of these patterns.

\n
\n \n
\n
\n
\n
\n
\n

namespace [required]

\n
\n

string

\n

The AWS CloudWatch namespace to which this metric name filter applies.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

namespace_filters

\n
\n

 <oneOf>

\n

AWS Metrics namespace filters. Defaults to exclude_only.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

Exclude only these namespaces from metrics collection.\nDefaults to ["AWS/SQS", "AWS/ElasticMapReduce", "AWS/Usage"].\nAWS/SQS, AWS/ElasticMapReduce, and AWS/Usage are excluded by default\nto reduce your AWS CloudWatch costs from GetMetricData API calls.

\n
\n
\n
\n
\n
\n

exclude_only [required]

\n
\n

[string]

\n

Exclude only these namespaces from metrics collection.\nDefaults to ["AWS/SQS", "AWS/ElasticMapReduce", "AWS/Usage"].\nAWS/SQS, AWS/ElasticMapReduce, and AWS/Usage are excluded by default\nto reduce your AWS CloudWatch costs from GetMetricData API calls.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Include only these namespaces.

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these namespaces.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tag_filters

\n
\n

[object]

\n

AWS Metrics collection tag filters list. Defaults to [].

\n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

The AWS service for which the tag filters defined in tags will be applied.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

The AWS resource tags to filter on for the service specified by namespace.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the account integration was updated.

\n
\n \n
\n
\n
\n
\n
\n

resources_config

\n
\n

object

\n

AWS Resources Collection config.

\n
\n
\n
\n
\n
\n

cloud_security_posture_management_collection

\n
\n

boolean

\n

Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations,\nidentity risks, and compliance violations. Defaults to false.\nRequires extended_collection to be set to true.

\n
\n \n
\n
\n
\n
\n
\n

extended_collection

\n
\n

boolean

\n

Whether Datadog collects additional attributes and configuration information about the resources\nin your AWS account. Defaults to true. Required for cloud_security_posture_management_collection.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

traces_config

\n
\n

object

\n

AWS Traces Collection config.

\n
\n
\n
\n
\n
\n

xray_services

\n
\n

 <oneOf>

\n

AWS X-Ray services to collect traces from. Defaults to include_only.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

Include all services.

\n
\n
\n
\n
\n
\n

include_all [required]

\n
\n

boolean

\n

Include all services.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Include only these services. Defaults to [].

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these services.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Unique Datadog ID of the AWS Account Integration Config.\nTo get the config ID for an account, use the\nList all AWS integrations\nendpoint and query by AWS Account ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

AWS Account resource type. \nAllowed enum values: account

default: account

\n
\n \n
\n
\n
\n
" }, "403": { "json": { @@ -119,8 +118,7 @@ "env:prod" ], "auth_config": { - "access_key_id": "AKIAIOSFODNN7EXAMPLE", - "secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY" + "access_key_id": "AKIAIOSFODNN7EXAMPLE" }, "aws_account_id": "123456789012", "aws_partition": "aws", @@ -192,7 +190,7 @@ "type": "account" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

AWS Account response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

AWS Account response attributes.

\n
\n
\n
\n
\n
\n

account_tags

\n
\n

[string]

\n

Tags to apply to all hosts and metrics reporting for this account. Defaults to [].

\n
\n \n
\n
\n
\n
\n
\n

auth_config

\n
\n

 <oneOf>

\n

AWS Authentication config.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

AWS Authentication config to integrate your account using an access key pair.

\n
\n
\n
\n
\n
\n

access_key_id [required]

\n
\n

string

\n

AWS Access Key ID.

\n
\n \n
\n
\n
\n
\n
\n

secret_access_key

\n
\n

string

\n

AWS Secret Access Key.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

AWS Authentication config to integrate your account using an IAM role.

\n
\n
\n
\n
\n
\n

external_id

\n
\n

string

\n

AWS IAM External ID for associated role.

\n
\n \n
\n
\n
\n
\n
\n

role_name [required]

\n
\n

string

\n

AWS IAM Role name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

aws_account_id [required]

\n
\n

string

\n

AWS Account ID.

\n
\n \n
\n
\n
\n
\n
\n

aws_partition

\n
\n

enum

\n

AWS partition your AWS account is scoped to. Defaults to aws.\nSee Partitions\nin the AWS documentation for more information. \nAllowed enum values: aws,aws-cn,aws-us-gov

\n
\n \n
\n
\n
\n
\n
\n

aws_regions

\n
\n

 <oneOf>

\n

AWS Regions to collect data from. Defaults to include_all.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

Include all regions. Defaults to true.

\n
\n
\n
\n
\n
\n

include_all [required]

\n
\n

boolean

\n

Include all regions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Include only these regions.

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these regions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the account integration was created.

\n
\n \n
\n
\n
\n
\n
\n

logs_config

\n
\n

object

\n

AWS Logs Collection config.

\n
\n
\n
\n
\n
\n

lambda_forwarder

\n
\n

object

\n

Log Autosubscription configuration for Datadog Forwarder Lambda functions.\nAutomatically set up triggers for existing and new logs for some services,\nensuring no logs from new resources are missed and saving time spent on manual configuration.

\n
\n
\n
\n
\n
\n

lambdas

\n
\n

[string]

\n

List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to [].

\n
\n \n
\n
\n
\n
\n
\n

log_source_config

\n
\n

object

\n

Log source configuration.

\n
\n
\n
\n
\n
\n

tag_filters

\n
\n

[object]

\n

List of AWS log source tag filters. Defaults to [].

\n
\n
\n
\n
\n
\n

source

\n
\n

string

\n

The AWS log source to which the tag filters defined in tags are applied.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

The AWS resource tags to filter on for the log source specified by source.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

sources

\n
\n

[string]

\n

List of service IDs set to enable automatic log collection.\nDiscover the list of available services with the\nGet list of AWS log ready\nservices\nendpoint.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

metrics_config

\n
\n

object

\n

AWS Metrics Collection config.

\n
\n
\n
\n
\n
\n

automute_enabled

\n
\n

boolean

\n

Enable EC2 automute for AWS metrics. Defaults to true.

\n
\n \n
\n
\n
\n
\n
\n

collect_cloudwatch_alarms

\n
\n

boolean

\n

Enable CloudWatch alarms collection. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

collect_custom_metrics

\n
\n

boolean

\n

Enable custom metrics collection. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Enable AWS metrics collection. Defaults to true.

\n
\n \n
\n
\n
\n
\n
\n

metric_name_filters

\n
\n

[ <oneOf>]

\n

AWS CloudWatch metric name filters. Each filter applies to a single namespace.\nExactly one of include_only or exclude_only must be set on each filter.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

Include only metric names matching one of these patterns for a single namespace.

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only metric names matching one of these patterns.

\n
\n \n
\n
\n
\n
\n
\n

namespace [required]

\n
\n

string

\n

The AWS CloudWatch namespace to which this metric name filter applies.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Exclude metric names matching one of these patterns for a single namespace.

\n
\n
\n
\n
\n
\n

exclude_only [required]

\n
\n

[string]

\n

Exclude metric names matching one of these patterns.

\n
\n \n
\n
\n
\n
\n
\n

namespace [required]

\n
\n

string

\n

The AWS CloudWatch namespace to which this metric name filter applies.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

namespace_filters

\n
\n

 <oneOf>

\n

AWS Metrics namespace filters. Defaults to exclude_only.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

Exclude only these namespaces from metrics collection.\nDefaults to ["AWS/SQS", "AWS/ElasticMapReduce", "AWS/Usage"].\nAWS/SQS, AWS/ElasticMapReduce, and AWS/Usage are excluded by default\nto reduce your AWS CloudWatch costs from GetMetricData API calls.

\n
\n
\n
\n
\n
\n

exclude_only [required]

\n
\n

[string]

\n

Exclude only these namespaces from metrics collection.\nDefaults to ["AWS/SQS", "AWS/ElasticMapReduce", "AWS/Usage"].\nAWS/SQS, AWS/ElasticMapReduce, and AWS/Usage are excluded by default\nto reduce your AWS CloudWatch costs from GetMetricData API calls.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Include only these namespaces.

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these namespaces.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tag_filters

\n
\n

[object]

\n

AWS Metrics collection tag filters list. Defaults to [].

\n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

The AWS service for which the tag filters defined in tags will be applied.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

The AWS resource tags to filter on for the service specified by namespace.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the account integration was updated.

\n
\n \n
\n
\n
\n
\n
\n

resources_config

\n
\n

object

\n

AWS Resources Collection config.

\n
\n
\n
\n
\n
\n

cloud_security_posture_management_collection

\n
\n

boolean

\n

Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations,\nidentity risks, and compliance violations. Defaults to false.\nRequires extended_collection to be set to true.

\n
\n \n
\n
\n
\n
\n
\n

extended_collection

\n
\n

boolean

\n

Whether Datadog collects additional attributes and configuration information about the resources\nin your AWS account. Defaults to true. Required for cloud_security_posture_management_collection.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

traces_config

\n
\n

object

\n

AWS Traces Collection config.

\n
\n
\n
\n
\n
\n

xray_services

\n
\n

 <oneOf>

\n

AWS X-Ray services to collect traces from. Defaults to include_only.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

Include all services.

\n
\n
\n
\n
\n
\n

include_all [required]

\n
\n

boolean

\n

Include all services.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Include only these services. Defaults to [].

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these services.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Unique Datadog ID of the AWS Account Integration Config.\nTo get the config ID for an account, use the\nList all AWS integrations\nendpoint and query by AWS Account ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

AWS Account resource type. \nAllowed enum values: account

default: account

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

AWS Account response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

AWS Account response attributes.

\n
\n
\n
\n
\n
\n

account_tags

\n
\n

[string]

\n

Tags to apply to all hosts and metrics reporting for this account. Defaults to [].

\n
\n \n
\n
\n
\n
\n
\n

auth_config

\n
\n

 <oneOf>

\n

AWS Authentication config.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

AWS Authentication config to integrate your account using an access key pair.

\n
\n
\n
\n
\n
\n

access_key_id [required]

\n
\n

string

\n

AWS Access Key ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

AWS Authentication config to integrate your account using an IAM role.

\n
\n
\n
\n
\n
\n

external_id

\n
\n

string

\n

AWS IAM External ID for associated role.

\n
\n \n
\n
\n
\n
\n
\n

role_name [required]

\n
\n

string

\n

AWS IAM Role name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

aws_account_id [required]

\n
\n

string

\n

AWS Account ID.

\n
\n \n
\n
\n
\n
\n
\n

aws_partition

\n
\n

enum

\n

AWS partition your AWS account is scoped to. Defaults to aws.\nSee Partitions\nin the AWS documentation for more information. \nAllowed enum values: aws,aws-cn,aws-us-gov

\n
\n \n
\n
\n
\n
\n
\n

aws_regions

\n
\n

 <oneOf>

\n

AWS Regions to collect data from. Defaults to include_all.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

Include all regions. Defaults to true.

\n
\n
\n
\n
\n
\n

include_all [required]

\n
\n

boolean

\n

Include all regions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Include only these regions.

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these regions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the account integration was created.

\n
\n \n
\n
\n
\n
\n
\n

logs_config

\n
\n

object

\n

AWS Logs Collection config.

\n
\n
\n
\n
\n
\n

lambda_forwarder

\n
\n

object

\n

Log Autosubscription configuration for Datadog Forwarder Lambda functions.\nAutomatically set up triggers for existing and new logs for some services,\nensuring no logs from new resources are missed and saving time spent on manual configuration.

\n
\n
\n
\n
\n
\n

lambdas

\n
\n

[string]

\n

List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to [].

\n
\n \n
\n
\n
\n
\n
\n

log_source_config

\n
\n

object

\n

Log source configuration.

\n
\n
\n
\n
\n
\n

tag_filters

\n
\n

[object]

\n

List of AWS log source tag filters. Defaults to [].

\n
\n
\n
\n
\n
\n

source

\n
\n

string

\n

The AWS log source to which the tag filters defined in tags are applied.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

The AWS resource tags to filter on for the log source specified by source.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

sources

\n
\n

[string]

\n

List of service IDs set to enable automatic log collection.\nDiscover the list of available services with the\nGet list of AWS log ready\nservices\nendpoint.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

metrics_config

\n
\n

object

\n

AWS Metrics Collection config.

\n
\n
\n
\n
\n
\n

automute_enabled

\n
\n

boolean

\n

Enable EC2 automute for AWS metrics. Defaults to true.

\n
\n \n
\n
\n
\n
\n
\n

collect_cloudwatch_alarms

\n
\n

boolean

\n

Enable CloudWatch alarms collection. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

collect_custom_metrics

\n
\n

boolean

\n

Enable custom metrics collection. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Enable AWS metrics collection. Defaults to true.

\n
\n \n
\n
\n
\n
\n
\n

metric_name_filters

\n
\n

[ <oneOf>]

\n

AWS CloudWatch metric name filters. Each filter applies to a single namespace.\nExactly one of include_only or exclude_only must be set on each filter.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

Include only metric names matching one of these patterns for a single namespace.

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only metric names matching one of these patterns.

\n
\n \n
\n
\n
\n
\n
\n

namespace [required]

\n
\n

string

\n

The AWS CloudWatch namespace to which this metric name filter applies.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Exclude metric names matching one of these patterns for a single namespace.

\n
\n
\n
\n
\n
\n

exclude_only [required]

\n
\n

[string]

\n

Exclude metric names matching one of these patterns.

\n
\n \n
\n
\n
\n
\n
\n

namespace [required]

\n
\n

string

\n

The AWS CloudWatch namespace to which this metric name filter applies.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

namespace_filters

\n
\n

 <oneOf>

\n

AWS Metrics namespace filters. Defaults to exclude_only.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

Exclude only these namespaces from metrics collection.\nDefaults to ["AWS/SQS", "AWS/ElasticMapReduce", "AWS/Usage"].\nAWS/SQS, AWS/ElasticMapReduce, and AWS/Usage are excluded by default\nto reduce your AWS CloudWatch costs from GetMetricData API calls.

\n
\n
\n
\n
\n
\n

exclude_only [required]

\n
\n

[string]

\n

Exclude only these namespaces from metrics collection.\nDefaults to ["AWS/SQS", "AWS/ElasticMapReduce", "AWS/Usage"].\nAWS/SQS, AWS/ElasticMapReduce, and AWS/Usage are excluded by default\nto reduce your AWS CloudWatch costs from GetMetricData API calls.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Include only these namespaces.

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these namespaces.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tag_filters

\n
\n

[object]

\n

AWS Metrics collection tag filters list. Defaults to [].

\n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

The AWS service for which the tag filters defined in tags will be applied.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

The AWS resource tags to filter on for the service specified by namespace.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the account integration was updated.

\n
\n \n
\n
\n
\n
\n
\n

resources_config

\n
\n

object

\n

AWS Resources Collection config.

\n
\n
\n
\n
\n
\n

cloud_security_posture_management_collection

\n
\n

boolean

\n

Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations,\nidentity risks, and compliance violations. Defaults to false.\nRequires extended_collection to be set to true.

\n
\n \n
\n
\n
\n
\n
\n

extended_collection

\n
\n

boolean

\n

Whether Datadog collects additional attributes and configuration information about the resources\nin your AWS account. Defaults to true. Required for cloud_security_posture_management_collection.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

traces_config

\n
\n

object

\n

AWS Traces Collection config.

\n
\n
\n
\n
\n
\n

xray_services

\n
\n

 <oneOf>

\n

AWS X-Ray services to collect traces from. Defaults to include_only.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

Include all services.

\n
\n
\n
\n
\n
\n

include_all [required]

\n
\n

boolean

\n

Include all services.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Include only these services. Defaults to [].

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these services.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Unique Datadog ID of the AWS Account Integration Config.\nTo get the config ID for an account, use the\nList all AWS integrations\nendpoint and query by AWS Account ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

AWS Account resource type. \nAllowed enum values: account

default: account

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -369,8 +367,7 @@ "env:prod" ], "auth_config": { - "access_key_id": "AKIAIOSFODNN7EXAMPLE", - "secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY" + "access_key_id": "AKIAIOSFODNN7EXAMPLE" }, "aws_account_id": "123456789012", "aws_partition": "aws", @@ -442,7 +439,7 @@ "type": "account" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

AWS Account response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

AWS Account response attributes.

\n
\n
\n
\n
\n
\n

account_tags

\n
\n

[string]

\n

Tags to apply to all hosts and metrics reporting for this account. Defaults to [].

\n
\n \n
\n
\n
\n
\n
\n

auth_config

\n
\n

 <oneOf>

\n

AWS Authentication config.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

AWS Authentication config to integrate your account using an access key pair.

\n
\n
\n
\n
\n
\n

access_key_id [required]

\n
\n

string

\n

AWS Access Key ID.

\n
\n \n
\n
\n
\n
\n
\n

secret_access_key

\n
\n

string

\n

AWS Secret Access Key.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

AWS Authentication config to integrate your account using an IAM role.

\n
\n
\n
\n
\n
\n

external_id

\n
\n

string

\n

AWS IAM External ID for associated role.

\n
\n \n
\n
\n
\n
\n
\n

role_name [required]

\n
\n

string

\n

AWS IAM Role name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

aws_account_id [required]

\n
\n

string

\n

AWS Account ID.

\n
\n \n
\n
\n
\n
\n
\n

aws_partition

\n
\n

enum

\n

AWS partition your AWS account is scoped to. Defaults to aws.\nSee Partitions\nin the AWS documentation for more information. \nAllowed enum values: aws,aws-cn,aws-us-gov

\n
\n \n
\n
\n
\n
\n
\n

aws_regions

\n
\n

 <oneOf>

\n

AWS Regions to collect data from. Defaults to include_all.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

Include all regions. Defaults to true.

\n
\n
\n
\n
\n
\n

include_all [required]

\n
\n

boolean

\n

Include all regions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Include only these regions.

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these regions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the account integration was created.

\n
\n \n
\n
\n
\n
\n
\n

logs_config

\n
\n

object

\n

AWS Logs Collection config.

\n
\n
\n
\n
\n
\n

lambda_forwarder

\n
\n

object

\n

Log Autosubscription configuration for Datadog Forwarder Lambda functions.\nAutomatically set up triggers for existing and new logs for some services,\nensuring no logs from new resources are missed and saving time spent on manual configuration.

\n
\n
\n
\n
\n
\n

lambdas

\n
\n

[string]

\n

List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to [].

\n
\n \n
\n
\n
\n
\n
\n

log_source_config

\n
\n

object

\n

Log source configuration.

\n
\n
\n
\n
\n
\n

tag_filters

\n
\n

[object]

\n

List of AWS log source tag filters. Defaults to [].

\n
\n
\n
\n
\n
\n

source

\n
\n

string

\n

The AWS log source to which the tag filters defined in tags are applied.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

The AWS resource tags to filter on for the log source specified by source.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

sources

\n
\n

[string]

\n

List of service IDs set to enable automatic log collection.\nDiscover the list of available services with the\nGet list of AWS log ready\nservices\nendpoint.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

metrics_config

\n
\n

object

\n

AWS Metrics Collection config.

\n
\n
\n
\n
\n
\n

automute_enabled

\n
\n

boolean

\n

Enable EC2 automute for AWS metrics. Defaults to true.

\n
\n \n
\n
\n
\n
\n
\n

collect_cloudwatch_alarms

\n
\n

boolean

\n

Enable CloudWatch alarms collection. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

collect_custom_metrics

\n
\n

boolean

\n

Enable custom metrics collection. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Enable AWS metrics collection. Defaults to true.

\n
\n \n
\n
\n
\n
\n
\n

metric_name_filters

\n
\n

[ <oneOf>]

\n

AWS CloudWatch metric name filters. Each filter applies to a single namespace.\nExactly one of include_only or exclude_only must be set on each filter.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

Include only metric names matching one of these patterns for a single namespace.

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only metric names matching one of these patterns.

\n
\n \n
\n
\n
\n
\n
\n

namespace [required]

\n
\n

string

\n

The AWS CloudWatch namespace to which this metric name filter applies.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Exclude metric names matching one of these patterns for a single namespace.

\n
\n
\n
\n
\n
\n

exclude_only [required]

\n
\n

[string]

\n

Exclude metric names matching one of these patterns.

\n
\n \n
\n
\n
\n
\n
\n

namespace [required]

\n
\n

string

\n

The AWS CloudWatch namespace to which this metric name filter applies.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

namespace_filters

\n
\n

 <oneOf>

\n

AWS Metrics namespace filters. Defaults to exclude_only.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

Exclude only these namespaces from metrics collection.\nDefaults to ["AWS/SQS", "AWS/ElasticMapReduce", "AWS/Usage"].\nAWS/SQS, AWS/ElasticMapReduce, and AWS/Usage are excluded by default\nto reduce your AWS CloudWatch costs from GetMetricData API calls.

\n
\n
\n
\n
\n
\n

exclude_only [required]

\n
\n

[string]

\n

Exclude only these namespaces from metrics collection.\nDefaults to ["AWS/SQS", "AWS/ElasticMapReduce", "AWS/Usage"].\nAWS/SQS, AWS/ElasticMapReduce, and AWS/Usage are excluded by default\nto reduce your AWS CloudWatch costs from GetMetricData API calls.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Include only these namespaces.

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these namespaces.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tag_filters

\n
\n

[object]

\n

AWS Metrics collection tag filters list. Defaults to [].

\n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

The AWS service for which the tag filters defined in tags will be applied.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

The AWS resource tags to filter on for the service specified by namespace.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the account integration was updated.

\n
\n \n
\n
\n
\n
\n
\n

resources_config

\n
\n

object

\n

AWS Resources Collection config.

\n
\n
\n
\n
\n
\n

cloud_security_posture_management_collection

\n
\n

boolean

\n

Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations,\nidentity risks, and compliance violations. Defaults to false.\nRequires extended_collection to be set to true.

\n
\n \n
\n
\n
\n
\n
\n

extended_collection

\n
\n

boolean

\n

Whether Datadog collects additional attributes and configuration information about the resources\nin your AWS account. Defaults to true. Required for cloud_security_posture_management_collection.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

traces_config

\n
\n

object

\n

AWS Traces Collection config.

\n
\n
\n
\n
\n
\n

xray_services

\n
\n

 <oneOf>

\n

AWS X-Ray services to collect traces from. Defaults to include_only.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

Include all services.

\n
\n
\n
\n
\n
\n

include_all [required]

\n
\n

boolean

\n

Include all services.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Include only these services. Defaults to [].

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these services.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Unique Datadog ID of the AWS Account Integration Config.\nTo get the config ID for an account, use the\nList all AWS integrations\nendpoint and query by AWS Account ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

AWS Account resource type. \nAllowed enum values: account

default: account

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

AWS Account response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

AWS Account response attributes.

\n
\n
\n
\n
\n
\n

account_tags

\n
\n

[string]

\n

Tags to apply to all hosts and metrics reporting for this account. Defaults to [].

\n
\n \n
\n
\n
\n
\n
\n

auth_config

\n
\n

 <oneOf>

\n

AWS Authentication config.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

AWS Authentication config to integrate your account using an access key pair.

\n
\n
\n
\n
\n
\n

access_key_id [required]

\n
\n

string

\n

AWS Access Key ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

AWS Authentication config to integrate your account using an IAM role.

\n
\n
\n
\n
\n
\n

external_id

\n
\n

string

\n

AWS IAM External ID for associated role.

\n
\n \n
\n
\n
\n
\n
\n

role_name [required]

\n
\n

string

\n

AWS IAM Role name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

aws_account_id [required]

\n
\n

string

\n

AWS Account ID.

\n
\n \n
\n
\n
\n
\n
\n

aws_partition

\n
\n

enum

\n

AWS partition your AWS account is scoped to. Defaults to aws.\nSee Partitions\nin the AWS documentation for more information. \nAllowed enum values: aws,aws-cn,aws-us-gov

\n
\n \n
\n
\n
\n
\n
\n

aws_regions

\n
\n

 <oneOf>

\n

AWS Regions to collect data from. Defaults to include_all.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

Include all regions. Defaults to true.

\n
\n
\n
\n
\n
\n

include_all [required]

\n
\n

boolean

\n

Include all regions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Include only these regions.

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these regions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the account integration was created.

\n
\n \n
\n
\n
\n
\n
\n

logs_config

\n
\n

object

\n

AWS Logs Collection config.

\n
\n
\n
\n
\n
\n

lambda_forwarder

\n
\n

object

\n

Log Autosubscription configuration for Datadog Forwarder Lambda functions.\nAutomatically set up triggers for existing and new logs for some services,\nensuring no logs from new resources are missed and saving time spent on manual configuration.

\n
\n
\n
\n
\n
\n

lambdas

\n
\n

[string]

\n

List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to [].

\n
\n \n
\n
\n
\n
\n
\n

log_source_config

\n
\n

object

\n

Log source configuration.

\n
\n
\n
\n
\n
\n

tag_filters

\n
\n

[object]

\n

List of AWS log source tag filters. Defaults to [].

\n
\n
\n
\n
\n
\n

source

\n
\n

string

\n

The AWS log source to which the tag filters defined in tags are applied.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

The AWS resource tags to filter on for the log source specified by source.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

sources

\n
\n

[string]

\n

List of service IDs set to enable automatic log collection.\nDiscover the list of available services with the\nGet list of AWS log ready\nservices\nendpoint.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

metrics_config

\n
\n

object

\n

AWS Metrics Collection config.

\n
\n
\n
\n
\n
\n

automute_enabled

\n
\n

boolean

\n

Enable EC2 automute for AWS metrics. Defaults to true.

\n
\n \n
\n
\n
\n
\n
\n

collect_cloudwatch_alarms

\n
\n

boolean

\n

Enable CloudWatch alarms collection. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

collect_custom_metrics

\n
\n

boolean

\n

Enable custom metrics collection. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Enable AWS metrics collection. Defaults to true.

\n
\n \n
\n
\n
\n
\n
\n

metric_name_filters

\n
\n

[ <oneOf>]

\n

AWS CloudWatch metric name filters. Each filter applies to a single namespace.\nExactly one of include_only or exclude_only must be set on each filter.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

Include only metric names matching one of these patterns for a single namespace.

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only metric names matching one of these patterns.

\n
\n \n
\n
\n
\n
\n
\n

namespace [required]

\n
\n

string

\n

The AWS CloudWatch namespace to which this metric name filter applies.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Exclude metric names matching one of these patterns for a single namespace.

\n
\n
\n
\n
\n
\n

exclude_only [required]

\n
\n

[string]

\n

Exclude metric names matching one of these patterns.

\n
\n \n
\n
\n
\n
\n
\n

namespace [required]

\n
\n

string

\n

The AWS CloudWatch namespace to which this metric name filter applies.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

namespace_filters

\n
\n

 <oneOf>

\n

AWS Metrics namespace filters. Defaults to exclude_only.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

Exclude only these namespaces from metrics collection.\nDefaults to ["AWS/SQS", "AWS/ElasticMapReduce", "AWS/Usage"].\nAWS/SQS, AWS/ElasticMapReduce, and AWS/Usage are excluded by default\nto reduce your AWS CloudWatch costs from GetMetricData API calls.

\n
\n
\n
\n
\n
\n

exclude_only [required]

\n
\n

[string]

\n

Exclude only these namespaces from metrics collection.\nDefaults to ["AWS/SQS", "AWS/ElasticMapReduce", "AWS/Usage"].\nAWS/SQS, AWS/ElasticMapReduce, and AWS/Usage are excluded by default\nto reduce your AWS CloudWatch costs from GetMetricData API calls.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Include only these namespaces.

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these namespaces.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tag_filters

\n
\n

[object]

\n

AWS Metrics collection tag filters list. Defaults to [].

\n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

The AWS service for which the tag filters defined in tags will be applied.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

The AWS resource tags to filter on for the service specified by namespace.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the account integration was updated.

\n
\n \n
\n
\n
\n
\n
\n

resources_config

\n
\n

object

\n

AWS Resources Collection config.

\n
\n
\n
\n
\n
\n

cloud_security_posture_management_collection

\n
\n

boolean

\n

Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations,\nidentity risks, and compliance violations. Defaults to false.\nRequires extended_collection to be set to true.

\n
\n \n
\n
\n
\n
\n
\n

extended_collection

\n
\n

boolean

\n

Whether Datadog collects additional attributes and configuration information about the resources\nin your AWS account. Defaults to true. Required for cloud_security_posture_management_collection.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

traces_config

\n
\n

object

\n

AWS Traces Collection config.

\n
\n
\n
\n
\n
\n

xray_services

\n
\n

 <oneOf>

\n

AWS X-Ray services to collect traces from. Defaults to include_only.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

Include all services.

\n
\n
\n
\n
\n
\n

include_all [required]

\n
\n

boolean

\n

Include all services.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Include only these services. Defaults to [].

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these services.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Unique Datadog ID of the AWS Account Integration Config.\nTo get the config ID for an account, use the\nList all AWS integrations\nendpoint and query by AWS Account ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

AWS Account resource type. \nAllowed enum values: account

default: account

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -493,8 +490,7 @@ "env:prod" ], "auth_config": { - "access_key_id": "AKIAIOSFODNN7EXAMPLE", - "secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY" + "access_key_id": "AKIAIOSFODNN7EXAMPLE" }, "aws_account_id": "123456789012", "aws_partition": "aws", @@ -566,7 +562,7 @@ "type": "account" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

AWS Account response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

AWS Account response attributes.

\n
\n
\n
\n
\n
\n

account_tags

\n
\n

[string]

\n

Tags to apply to all hosts and metrics reporting for this account. Defaults to [].

\n
\n \n
\n
\n
\n
\n
\n

auth_config

\n
\n

 <oneOf>

\n

AWS Authentication config.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

AWS Authentication config to integrate your account using an access key pair.

\n
\n
\n
\n
\n
\n

access_key_id [required]

\n
\n

string

\n

AWS Access Key ID.

\n
\n \n
\n
\n
\n
\n
\n

secret_access_key

\n
\n

string

\n

AWS Secret Access Key.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

AWS Authentication config to integrate your account using an IAM role.

\n
\n
\n
\n
\n
\n

external_id

\n
\n

string

\n

AWS IAM External ID for associated role.

\n
\n \n
\n
\n
\n
\n
\n

role_name [required]

\n
\n

string

\n

AWS IAM Role name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

aws_account_id [required]

\n
\n

string

\n

AWS Account ID.

\n
\n \n
\n
\n
\n
\n
\n

aws_partition

\n
\n

enum

\n

AWS partition your AWS account is scoped to. Defaults to aws.\nSee Partitions\nin the AWS documentation for more information. \nAllowed enum values: aws,aws-cn,aws-us-gov

\n
\n \n
\n
\n
\n
\n
\n

aws_regions

\n
\n

 <oneOf>

\n

AWS Regions to collect data from. Defaults to include_all.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

Include all regions. Defaults to true.

\n
\n
\n
\n
\n
\n

include_all [required]

\n
\n

boolean

\n

Include all regions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Include only these regions.

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these regions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the account integration was created.

\n
\n \n
\n
\n
\n
\n
\n

logs_config

\n
\n

object

\n

AWS Logs Collection config.

\n
\n
\n
\n
\n
\n

lambda_forwarder

\n
\n

object

\n

Log Autosubscription configuration for Datadog Forwarder Lambda functions.\nAutomatically set up triggers for existing and new logs for some services,\nensuring no logs from new resources are missed and saving time spent on manual configuration.

\n
\n
\n
\n
\n
\n

lambdas

\n
\n

[string]

\n

List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to [].

\n
\n \n
\n
\n
\n
\n
\n

log_source_config

\n
\n

object

\n

Log source configuration.

\n
\n
\n
\n
\n
\n

tag_filters

\n
\n

[object]

\n

List of AWS log source tag filters. Defaults to [].

\n
\n
\n
\n
\n
\n

source

\n
\n

string

\n

The AWS log source to which the tag filters defined in tags are applied.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

The AWS resource tags to filter on for the log source specified by source.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

sources

\n
\n

[string]

\n

List of service IDs set to enable automatic log collection.\nDiscover the list of available services with the\nGet list of AWS log ready\nservices\nendpoint.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

metrics_config

\n
\n

object

\n

AWS Metrics Collection config.

\n
\n
\n
\n
\n
\n

automute_enabled

\n
\n

boolean

\n

Enable EC2 automute for AWS metrics. Defaults to true.

\n
\n \n
\n
\n
\n
\n
\n

collect_cloudwatch_alarms

\n
\n

boolean

\n

Enable CloudWatch alarms collection. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

collect_custom_metrics

\n
\n

boolean

\n

Enable custom metrics collection. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Enable AWS metrics collection. Defaults to true.

\n
\n \n
\n
\n
\n
\n
\n

metric_name_filters

\n
\n

[ <oneOf>]

\n

AWS CloudWatch metric name filters. Each filter applies to a single namespace.\nExactly one of include_only or exclude_only must be set on each filter.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

Include only metric names matching one of these patterns for a single namespace.

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only metric names matching one of these patterns.

\n
\n \n
\n
\n
\n
\n
\n

namespace [required]

\n
\n

string

\n

The AWS CloudWatch namespace to which this metric name filter applies.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Exclude metric names matching one of these patterns for a single namespace.

\n
\n
\n
\n
\n
\n

exclude_only [required]

\n
\n

[string]

\n

Exclude metric names matching one of these patterns.

\n
\n \n
\n
\n
\n
\n
\n

namespace [required]

\n
\n

string

\n

The AWS CloudWatch namespace to which this metric name filter applies.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

namespace_filters

\n
\n

 <oneOf>

\n

AWS Metrics namespace filters. Defaults to exclude_only.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

Exclude only these namespaces from metrics collection.\nDefaults to ["AWS/SQS", "AWS/ElasticMapReduce", "AWS/Usage"].\nAWS/SQS, AWS/ElasticMapReduce, and AWS/Usage are excluded by default\nto reduce your AWS CloudWatch costs from GetMetricData API calls.

\n
\n
\n
\n
\n
\n

exclude_only [required]

\n
\n

[string]

\n

Exclude only these namespaces from metrics collection.\nDefaults to ["AWS/SQS", "AWS/ElasticMapReduce", "AWS/Usage"].\nAWS/SQS, AWS/ElasticMapReduce, and AWS/Usage are excluded by default\nto reduce your AWS CloudWatch costs from GetMetricData API calls.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Include only these namespaces.

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these namespaces.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tag_filters

\n
\n

[object]

\n

AWS Metrics collection tag filters list. Defaults to [].

\n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

The AWS service for which the tag filters defined in tags will be applied.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

The AWS resource tags to filter on for the service specified by namespace.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the account integration was updated.

\n
\n \n
\n
\n
\n
\n
\n

resources_config

\n
\n

object

\n

AWS Resources Collection config.

\n
\n
\n
\n
\n
\n

cloud_security_posture_management_collection

\n
\n

boolean

\n

Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations,\nidentity risks, and compliance violations. Defaults to false.\nRequires extended_collection to be set to true.

\n
\n \n
\n
\n
\n
\n
\n

extended_collection

\n
\n

boolean

\n

Whether Datadog collects additional attributes and configuration information about the resources\nin your AWS account. Defaults to true. Required for cloud_security_posture_management_collection.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

traces_config

\n
\n

object

\n

AWS Traces Collection config.

\n
\n
\n
\n
\n
\n

xray_services

\n
\n

 <oneOf>

\n

AWS X-Ray services to collect traces from. Defaults to include_only.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

Include all services.

\n
\n
\n
\n
\n
\n

include_all [required]

\n
\n

boolean

\n

Include all services.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Include only these services. Defaults to [].

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these services.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Unique Datadog ID of the AWS Account Integration Config.\nTo get the config ID for an account, use the\nList all AWS integrations\nendpoint and query by AWS Account ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

AWS Account resource type. \nAllowed enum values: account

default: account

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

AWS Account response data.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

AWS Account response attributes.

\n
\n
\n
\n
\n
\n

account_tags

\n
\n

[string]

\n

Tags to apply to all hosts and metrics reporting for this account. Defaults to [].

\n
\n \n
\n
\n
\n
\n
\n

auth_config

\n
\n

 <oneOf>

\n

AWS Authentication config.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

AWS Authentication config to integrate your account using an access key pair.

\n
\n
\n
\n
\n
\n

access_key_id [required]

\n
\n

string

\n

AWS Access Key ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

AWS Authentication config to integrate your account using an IAM role.

\n
\n
\n
\n
\n
\n

external_id

\n
\n

string

\n

AWS IAM External ID for associated role.

\n
\n \n
\n
\n
\n
\n
\n

role_name [required]

\n
\n

string

\n

AWS IAM Role name.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

aws_account_id [required]

\n
\n

string

\n

AWS Account ID.

\n
\n \n
\n
\n
\n
\n
\n

aws_partition

\n
\n

enum

\n

AWS partition your AWS account is scoped to. Defaults to aws.\nSee Partitions\nin the AWS documentation for more information. \nAllowed enum values: aws,aws-cn,aws-us-gov

\n
\n \n
\n
\n
\n
\n
\n

aws_regions

\n
\n

 <oneOf>

\n

AWS Regions to collect data from. Defaults to include_all.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

Include all regions. Defaults to true.

\n
\n
\n
\n
\n
\n

include_all [required]

\n
\n

boolean

\n

Include all regions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Include only these regions.

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these regions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

created_at

\n
\n

date-time

\n

Timestamp of when the account integration was created.

\n
\n \n
\n
\n
\n
\n
\n

logs_config

\n
\n

object

\n

AWS Logs Collection config.

\n
\n
\n
\n
\n
\n

lambda_forwarder

\n
\n

object

\n

Log Autosubscription configuration for Datadog Forwarder Lambda functions.\nAutomatically set up triggers for existing and new logs for some services,\nensuring no logs from new resources are missed and saving time spent on manual configuration.

\n
\n
\n
\n
\n
\n

lambdas

\n
\n

[string]

\n

List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to [].

\n
\n \n
\n
\n
\n
\n
\n

log_source_config

\n
\n

object

\n

Log source configuration.

\n
\n
\n
\n
\n
\n

tag_filters

\n
\n

[object]

\n

List of AWS log source tag filters. Defaults to [].

\n
\n
\n
\n
\n
\n

source

\n
\n

string

\n

The AWS log source to which the tag filters defined in tags are applied.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

The AWS resource tags to filter on for the log source specified by source.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

sources

\n
\n

[string]

\n

List of service IDs set to enable automatic log collection.\nDiscover the list of available services with the\nGet list of AWS log ready\nservices\nendpoint.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

metrics_config

\n
\n

object

\n

AWS Metrics Collection config.

\n
\n
\n
\n
\n
\n

automute_enabled

\n
\n

boolean

\n

Enable EC2 automute for AWS metrics. Defaults to true.

\n
\n \n
\n
\n
\n
\n
\n

collect_cloudwatch_alarms

\n
\n

boolean

\n

Enable CloudWatch alarms collection. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

collect_custom_metrics

\n
\n

boolean

\n

Enable custom metrics collection. Defaults to false.

\n
\n \n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Enable AWS metrics collection. Defaults to true.

\n
\n \n
\n
\n
\n
\n
\n

metric_name_filters

\n
\n

[ <oneOf>]

\n

AWS CloudWatch metric name filters. Each filter applies to a single namespace.\nExactly one of include_only or exclude_only must be set on each filter.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

Include only metric names matching one of these patterns for a single namespace.

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only metric names matching one of these patterns.

\n
\n \n
\n
\n
\n
\n
\n

namespace [required]

\n
\n

string

\n

The AWS CloudWatch namespace to which this metric name filter applies.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Exclude metric names matching one of these patterns for a single namespace.

\n
\n
\n
\n
\n
\n

exclude_only [required]

\n
\n

[string]

\n

Exclude metric names matching one of these patterns.

\n
\n \n
\n
\n
\n
\n
\n

namespace [required]

\n
\n

string

\n

The AWS CloudWatch namespace to which this metric name filter applies.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

namespace_filters

\n
\n

 <oneOf>

\n

AWS Metrics namespace filters. Defaults to exclude_only.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

Exclude only these namespaces from metrics collection.\nDefaults to ["AWS/SQS", "AWS/ElasticMapReduce", "AWS/Usage"].\nAWS/SQS, AWS/ElasticMapReduce, and AWS/Usage are excluded by default\nto reduce your AWS CloudWatch costs from GetMetricData API calls.

\n
\n
\n
\n
\n
\n

exclude_only [required]

\n
\n

[string]

\n

Exclude only these namespaces from metrics collection.\nDefaults to ["AWS/SQS", "AWS/ElasticMapReduce", "AWS/Usage"].\nAWS/SQS, AWS/ElasticMapReduce, and AWS/Usage are excluded by default\nto reduce your AWS CloudWatch costs from GetMetricData API calls.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Include only these namespaces.

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these namespaces.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tag_filters

\n
\n

[object]

\n

AWS Metrics collection tag filters list. Defaults to [].

\n
\n
\n
\n
\n
\n

namespace

\n
\n

string

\n

The AWS service for which the tag filters defined in tags will be applied.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

The AWS resource tags to filter on for the service specified by namespace.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

modified_at

\n
\n

date-time

\n

Timestamp of when the account integration was updated.

\n
\n \n
\n
\n
\n
\n
\n

resources_config

\n
\n

object

\n

AWS Resources Collection config.

\n
\n
\n
\n
\n
\n

cloud_security_posture_management_collection

\n
\n

boolean

\n

Enable Cloud Security Management to scan AWS resources for vulnerabilities, misconfigurations,\nidentity risks, and compliance violations. Defaults to false.\nRequires extended_collection to be set to true.

\n
\n \n
\n
\n
\n
\n
\n

extended_collection

\n
\n

boolean

\n

Whether Datadog collects additional attributes and configuration information about the resources\nin your AWS account. Defaults to true. Required for cloud_security_posture_management_collection.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

traces_config

\n
\n

object

\n

AWS Traces Collection config.

\n
\n
\n
\n
\n
\n

xray_services

\n
\n

 <oneOf>

\n

AWS X-Ray services to collect traces from. Defaults to include_only.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

Include all services.

\n
\n
\n
\n
\n
\n

include_all [required]

\n
\n

boolean

\n

Include all services.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Include only these services. Defaults to [].

\n
\n
\n
\n
\n
\n

include_only [required]

\n
\n

[string]

\n

Include only these services.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

Unique Datadog ID of the AWS Account Integration Config.\nTo get the config ID for an account, use the\nList all AWS integrations\nendpoint and query by AWS Account ID.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

AWS Account resource type. \nAllowed enum values: account

default: account

\n
\n \n
\n
\n
\n
" }, "400": { "json": { diff --git a/hugo/content/en/api/v2/cloud-cost-management/examples.json b/hugo/content/en/api/v2/cloud-cost-management/examples.json index fb63e43937f..d59a91f1a1e 100644 --- a/hugo/content/en/api/v2/cloud-cost-management/examples.json +++ b/hugo/content/en/api/v2/cloud-cost-management/examples.json @@ -4226,6 +4226,553 @@ "html": "" } }, + "ListUnitCosts": { + "responses": { + "200": { + "json": { + "data": [ + { + "attributes": { + "created_at": "2026-09-01T18:46:15.933716Z", + "created_by": "36ea1610-8866-4bd3-bb6d-9bb9fc87cad2", + "denominator_query": { + "formulas": [ + [] + ], + "queries": [ + [] + ] + }, + "denominator_type": "metrics", + "description": "Amortized cloud spend divided by the number of active users.", + "name": "Cloud cost per active user", + "numerator_query": { + "formulas": [ + [] + ], + "queries": [ + [] + ] + }, + "org_id": 321813, + "unit_label": "user", + "updated_at": "2026-09-01T19:52:08.820536Z", + "updated_by": "13cc0adf-2595-479e-b448-5051c180dddb" + }, + "id": "64aecd58-e355-4f07-9c3a-56ff6bda6cd8", + "type": "unit_cost" + } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

The list of unit costs.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attributes of a unit cost.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The time the unit cost was created.

\n
\n \n
\n
\n
\n
\n
\n

created_by [required]

\n
\n

uuid

\n

The UUID of the user who created the unit cost.

\n
\n \n
\n
\n
\n
\n
\n

denominator_query [required]

\n
\n

object

\n

A timeseries object containing queries and formulas arrays.

\n
\n
\n
\n
\n
\n

formulas [required]

\n
\n

[object]

\n

The list of formulas applied to the queries for this side of the ratio.

\n
\n \n
\n
\n
\n
\n
\n

queries [required]

\n
\n

[object]

\n

The list of queries evaluated for this side of the ratio.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

denominator_type [required]

\n
\n

string

\n

The data source of the denominator queries, or multisource when the denominator\nqueries span more than one data source.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The description of the unit cost. Omitted when the unit cost has no description.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the unit cost.

\n
\n \n
\n
\n
\n
\n
\n

numerator_query [required]

\n
\n

object

\n

A timeseries object containing queries and formulas arrays.

\n
\n
\n
\n
\n
\n

formulas [required]

\n
\n

[object]

\n

The list of formulas applied to the queries for this side of the ratio.

\n
\n \n
\n
\n
\n
\n
\n

queries [required]

\n
\n

[object]

\n

The list of queries evaluated for this side of the ratio.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

org_id [required]

\n
\n

int64

\n

The ID of the organization the unit cost belongs to.

\n
\n \n
\n
\n
\n
\n
\n

unit_label [required]

\n
\n

string

\n

The label describing the denominator unit.

\n
\n \n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The time the unit cost was last updated.

\n
\n \n
\n
\n
\n
\n
\n

updated_by [required]

\n
\n

uuid

\n

The UUID of the user who last updated the unit cost.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The UUID of the unit cost.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The JSON:API resource type for a unit cost. \nAllowed enum values: unit_cost

default: unit_cost

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "CreateUnitCost": { + "responses": { + "201": { + "json": { + "data": { + "attributes": { + "created_at": "2026-09-01T18:46:15.933716Z", + "created_by": "36ea1610-8866-4bd3-bb6d-9bb9fc87cad2", + "denominator_query": { + "formulas": [ + [] + ], + "queries": [ + [] + ] + }, + "denominator_type": "metrics", + "description": "Amortized cloud spend divided by the number of active users.", + "name": "Cloud cost per active user", + "numerator_query": { + "formulas": [ + [] + ], + "queries": [ + [] + ] + }, + "org_id": 321813, + "unit_label": "user", + "updated_at": "2026-09-01T19:52:08.820536Z", + "updated_by": "13cc0adf-2595-479e-b448-5051c180dddb" + }, + "id": "64aecd58-e355-4f07-9c3a-56ff6bda6cd8", + "type": "unit_cost" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object of a unit cost response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attributes of a unit cost.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The time the unit cost was created.

\n
\n \n
\n
\n
\n
\n
\n

created_by [required]

\n
\n

uuid

\n

The UUID of the user who created the unit cost.

\n
\n \n
\n
\n
\n
\n
\n

denominator_query [required]

\n
\n

object

\n

A timeseries object containing queries and formulas arrays.

\n
\n
\n
\n
\n
\n

formulas [required]

\n
\n

[object]

\n

The list of formulas applied to the queries for this side of the ratio.

\n
\n \n
\n
\n
\n
\n
\n

queries [required]

\n
\n

[object]

\n

The list of queries evaluated for this side of the ratio.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

denominator_type [required]

\n
\n

string

\n

The data source of the denominator queries, or multisource when the denominator\nqueries span more than one data source.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The description of the unit cost. Omitted when the unit cost has no description.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the unit cost.

\n
\n \n
\n
\n
\n
\n
\n

numerator_query [required]

\n
\n

object

\n

A timeseries object containing queries and formulas arrays.

\n
\n
\n
\n
\n
\n

formulas [required]

\n
\n

[object]

\n

The list of formulas applied to the queries for this side of the ratio.

\n
\n \n
\n
\n
\n
\n
\n

queries [required]

\n
\n

[object]

\n

The list of queries evaluated for this side of the ratio.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

org_id [required]

\n
\n

int64

\n

The ID of the organization the unit cost belongs to.

\n
\n \n
\n
\n
\n
\n
\n

unit_label [required]

\n
\n

string

\n

The label describing the denominator unit.

\n
\n \n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The time the unit cost was last updated.

\n
\n \n
\n
\n
\n
\n
\n

updated_by [required]

\n
\n

uuid

\n

The UUID of the user who last updated the unit cost.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The UUID of the unit cost.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The JSON:API resource type for a unit cost. \nAllowed enum values: unit_cost

default: unit_cost

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "attributes": { + "denominator_query": { + "formulas": [ + null + ], + "queries": [ + null + ] + }, + "name": "Cloud cost per active user", + "numerator_query": { + "formulas": [ + null + ], + "queries": [ + null + ] + }, + "unit_label": "user" + }, + "type": "unit_cost" + } + }, + "json": { + "data": { + "attributes": { + "denominator_query": { + "formulas": [ + [] + ], + "queries": [ + [] + ] + }, + "description": "Amortized cloud spend divided by the number of active users.", + "name": "Cloud cost per active user", + "numerator_query": { + "formulas": [ + [] + ], + "queries": [ + [] + ] + }, + "unit_label": "user" + }, + "type": "unit_cost" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object of a unit cost create request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attributes of a unit cost create or replace request.

\n
\n
\n
\n
\n
\n

denominator_query [required]

\n
\n

object

\n

A timeseries object containing queries and formulas arrays.

\n
\n
\n
\n
\n
\n

formulas [required]

\n
\n

[object]

\n

The list of formulas applied to the queries for this side of the ratio.

\n
\n \n
\n
\n
\n
\n
\n

queries [required]

\n
\n

[object]

\n

The list of queries evaluated for this side of the ratio.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

An optional description of the unit cost. At most 2000 characters.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the unit cost. At most 200 characters.

\n
\n \n
\n
\n
\n
\n
\n

numerator_query [required]

\n
\n

object

\n

A timeseries object containing queries and formulas arrays.

\n
\n
\n
\n
\n
\n

formulas [required]

\n
\n

[object]

\n

The list of formulas applied to the queries for this side of the ratio.

\n
\n \n
\n
\n
\n
\n
\n

queries [required]

\n
\n

[object]

\n

The list of queries evaluated for this side of the ratio.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

unit_label [required]

\n
\n

string

\n

The label describing the denominator unit, for example user. At most 100 characters.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The JSON:API resource type for a unit cost. \nAllowed enum values: unit_cost

default: unit_cost

\n
\n \n
\n
\n
\n
" + } + }, + "DeleteUnitCost": { + "responses": { + "400": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "404": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "GetUnitCost": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "created_at": "2026-09-01T18:46:15.933716Z", + "created_by": "36ea1610-8866-4bd3-bb6d-9bb9fc87cad2", + "denominator_query": { + "formulas": [ + [] + ], + "queries": [ + [] + ] + }, + "denominator_type": "metrics", + "description": "Amortized cloud spend divided by the number of active users.", + "name": "Cloud cost per active user", + "numerator_query": { + "formulas": [ + [] + ], + "queries": [ + [] + ] + }, + "org_id": 321813, + "unit_label": "user", + "updated_at": "2026-09-01T19:52:08.820536Z", + "updated_by": "13cc0adf-2595-479e-b448-5051c180dddb" + }, + "id": "64aecd58-e355-4f07-9c3a-56ff6bda6cd8", + "type": "unit_cost" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object of a unit cost response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attributes of a unit cost.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The time the unit cost was created.

\n
\n \n
\n
\n
\n
\n
\n

created_by [required]

\n
\n

uuid

\n

The UUID of the user who created the unit cost.

\n
\n \n
\n
\n
\n
\n
\n

denominator_query [required]

\n
\n

object

\n

A timeseries object containing queries and formulas arrays.

\n
\n
\n
\n
\n
\n

formulas [required]

\n
\n

[object]

\n

The list of formulas applied to the queries for this side of the ratio.

\n
\n \n
\n
\n
\n
\n
\n

queries [required]

\n
\n

[object]

\n

The list of queries evaluated for this side of the ratio.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

denominator_type [required]

\n
\n

string

\n

The data source of the denominator queries, or multisource when the denominator\nqueries span more than one data source.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The description of the unit cost. Omitted when the unit cost has no description.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the unit cost.

\n
\n \n
\n
\n
\n
\n
\n

numerator_query [required]

\n
\n

object

\n

A timeseries object containing queries and formulas arrays.

\n
\n
\n
\n
\n
\n

formulas [required]

\n
\n

[object]

\n

The list of formulas applied to the queries for this side of the ratio.

\n
\n \n
\n
\n
\n
\n
\n

queries [required]

\n
\n

[object]

\n

The list of queries evaluated for this side of the ratio.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

org_id [required]

\n
\n

int64

\n

The ID of the organization the unit cost belongs to.

\n
\n \n
\n
\n
\n
\n
\n

unit_label [required]

\n
\n

string

\n

The label describing the denominator unit.

\n
\n \n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The time the unit cost was last updated.

\n
\n \n
\n
\n
\n
\n
\n

updated_by [required]

\n
\n

uuid

\n

The UUID of the user who last updated the unit cost.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The UUID of the unit cost.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The JSON:API resource type for a unit cost. \nAllowed enum values: unit_cost

default: unit_cost

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "404": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + }, + "UpdateUnitCost": { + "responses": { + "200": { + "json": { + "data": { + "attributes": { + "created_at": "2026-09-01T18:46:15.933716Z", + "created_by": "36ea1610-8866-4bd3-bb6d-9bb9fc87cad2", + "denominator_query": { + "formulas": [ + [] + ], + "queries": [ + [] + ] + }, + "denominator_type": "metrics", + "description": "Amortized cloud spend divided by the number of active users.", + "name": "Cloud cost per active user", + "numerator_query": { + "formulas": [ + [] + ], + "queries": [ + [] + ] + }, + "org_id": 321813, + "unit_label": "user", + "updated_at": "2026-09-01T19:52:08.820536Z", + "updated_by": "13cc0adf-2595-479e-b448-5051c180dddb" + }, + "id": "64aecd58-e355-4f07-9c3a-56ff6bda6cd8", + "type": "unit_cost" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object of a unit cost response.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attributes of a unit cost.

\n
\n
\n
\n
\n
\n

created_at [required]

\n
\n

date-time

\n

The time the unit cost was created.

\n
\n \n
\n
\n
\n
\n
\n

created_by [required]

\n
\n

uuid

\n

The UUID of the user who created the unit cost.

\n
\n \n
\n
\n
\n
\n
\n

denominator_query [required]

\n
\n

object

\n

A timeseries object containing queries and formulas arrays.

\n
\n
\n
\n
\n
\n

formulas [required]

\n
\n

[object]

\n

The list of formulas applied to the queries for this side of the ratio.

\n
\n \n
\n
\n
\n
\n
\n

queries [required]

\n
\n

[object]

\n

The list of queries evaluated for this side of the ratio.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

denominator_type [required]

\n
\n

string

\n

The data source of the denominator queries, or multisource when the denominator\nqueries span more than one data source.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The description of the unit cost. Omitted when the unit cost has no description.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the unit cost.

\n
\n \n
\n
\n
\n
\n
\n

numerator_query [required]

\n
\n

object

\n

A timeseries object containing queries and formulas arrays.

\n
\n
\n
\n
\n
\n

formulas [required]

\n
\n

[object]

\n

The list of formulas applied to the queries for this side of the ratio.

\n
\n \n
\n
\n
\n
\n
\n

queries [required]

\n
\n

[object]

\n

The list of queries evaluated for this side of the ratio.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

org_id [required]

\n
\n

int64

\n

The ID of the organization the unit cost belongs to.

\n
\n \n
\n
\n
\n
\n
\n

unit_label [required]

\n
\n

string

\n

The label describing the denominator unit.

\n
\n \n
\n
\n
\n
\n
\n

updated_at [required]

\n
\n

date-time

\n

The time the unit cost was last updated.

\n
\n \n
\n
\n
\n
\n
\n

updated_by [required]

\n
\n

uuid

\n

The UUID of the user who last updated the unit cost.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The UUID of the unit cost.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The JSON:API resource type for a unit cost. \nAllowed enum values: unit_cost

default: unit_cost

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "404": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": { + "data": { + "attributes": { + "denominator_query": { + "formulas": [ + null + ], + "queries": [ + null + ] + }, + "name": "Cloud cost per active user", + "numerator_query": { + "formulas": [ + null + ], + "queries": [ + null + ] + }, + "unit_label": "user" + }, + "id": "64aecd58-e355-4f07-9c3a-56ff6bda6cd8", + "type": "unit_cost" + } + }, + "json": { + "data": { + "attributes": { + "denominator_query": { + "formulas": [ + [] + ], + "queries": [ + [] + ] + }, + "description": "Amortized cloud spend divided by the number of active users.", + "name": "Cloud cost per active user", + "numerator_query": { + "formulas": [ + [] + ], + "queries": [ + [] + ] + }, + "unit_label": "user" + }, + "id": "64aecd58-e355-4f07-9c3a-56ff6bda6cd8", + "type": "unit_cost" + } + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The data object of a unit cost replace request.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attributes of a unit cost create or replace request.

\n
\n
\n
\n
\n
\n

denominator_query [required]

\n
\n

object

\n

A timeseries object containing queries and formulas arrays.

\n
\n
\n
\n
\n
\n

formulas [required]

\n
\n

[object]

\n

The list of formulas applied to the queries for this side of the ratio.

\n
\n \n
\n
\n
\n
\n
\n

queries [required]

\n
\n

[object]

\n

The list of queries evaluated for this side of the ratio.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

An optional description of the unit cost. At most 2000 characters.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the unit cost. At most 200 characters.

\n
\n \n
\n
\n
\n
\n
\n

numerator_query [required]

\n
\n

object

\n

A timeseries object containing queries and formulas arrays.

\n
\n
\n
\n
\n
\n

formulas [required]

\n
\n

[object]

\n

The list of formulas applied to the queries for this side of the ratio.

\n
\n \n
\n
\n
\n
\n
\n

queries [required]

\n
\n

[object]

\n

The list of queries evaluated for this side of the ratio.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

unit_label [required]

\n
\n

string

\n

The label describing the denominator unit, for example user. At most 100 characters.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

uuid

\n

The UUID of the unit cost being replaced. Must match the unit_cost_id path parameter.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The JSON:API resource type for a unit cost. \nAllowed enum values: unit_cost

default: unit_cost

\n
\n \n
\n
\n
\n
" + } + }, "ListTagPipelinesRulesets": { "responses": { "200": { diff --git a/hugo/content/en/api/v2/logs-custom-destinations/examples.json b/hugo/content/en/api/v2/logs-custom-destinations/examples.json index 8a4d9ab6f2a..78ee3a5402d 100644 --- a/hugo/content/en/api/v2/logs-custom-destinations/examples.json +++ b/hugo/content/en/api/v2/logs-custom-destinations/examples.json @@ -28,7 +28,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

A list of custom destinations.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes associated with the custom destination.

\n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether logs matching this custom destination should be forwarded or not.

default: true

\n
\n \n
\n
\n
\n
\n
\n

forward_tags

\n
\n

boolean

\n

Whether tags from the forwarded logs should be forwarded or not.

default: true

\n
\n \n
\n
\n
\n
\n
\n

forward_tags_restriction_list

\n
\n

[string]

\n

List of keys of tags to be filtered.

An empty list represents no restriction is in place and either all or no tags will be\nforwarded depending on forward_tags_restriction_list_type parameter.

default:

\n
\n \n
\n
\n
\n
\n
\n

forward_tags_restriction_list_type

\n
\n

enum

\n

How forward_tags_restriction_list parameter should be interpreted.\nIf ALLOW_LIST, then only tags whose keys on the forwarded logs match the ones on the restriction list\nare forwarded.

BLOCK_LIST works the opposite way. It does not forward the tags matching the ones on the list. \nAllowed enum values: ALLOW_LIST,BLOCK_LIST

default: ALLOW_LIST

\n
\n \n
\n
\n
\n
\n
\n

forwarder_destination

\n
\n

 <oneOf>

\n

A custom destination's location to forward logs.

\n
\n
\n
\n
\n
\n

<type=http>

\n
\n

object

\n

The HTTP destination.

\n
\n
\n
\n
\n
\n

auth [required]

\n
\n

 <oneOf>

\n

Authentication method of the HTTP requests.

\n
\n
\n
\n
\n
\n

<type=basic>

\n
\n

object

\n

Basic access authentication.

\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the basic access authentication. \nAllowed enum values: basic

default: basic

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=custom_header>

\n
\n

object

\n

Custom header access authentication.

\n
\n
\n
\n
\n
\n

header_name [required]

\n
\n

string

\n

The header name of the authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the custom header access authentication. \nAllowed enum values: custom_header

default: custom_header

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

endpoint [required]

\n
\n

string

\n

The destination for which logs will be forwarded to.\nMust have HTTPS scheme and forwarding back to Datadog is not allowed.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the HTTP destination. \nAllowed enum values: http

default: http

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=splunk_hec>

\n
\n

object

\n

The Splunk HTTP Event Collector (HEC) destination.

\n
\n
\n
\n
\n
\n

endpoint [required]

\n
\n

string

\n

The destination for which logs will be forwarded to.\nMust have HTTPS scheme and forwarding back to Datadog is not allowed.

\n
\n \n
\n
\n
\n
\n
\n

sourcetype

\n
\n

string

\n

The Splunk sourcetype for the events sent to this Splunk destination.

If the field is absent from the request and no sourcetype has been previously set on this destination, the default sourcetype _json is used.\nOn update, if the field is absent from the request but a sourcetype was previously set, the previous value is kept.\nIf set to null, the sourcetype field is omitted from the forwarded event entirely.\nOtherwise, the provided string value is used as the sourcetype.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the Splunk HTTP Event Collector (HEC) destination. \nAllowed enum values: splunk_hec

default: splunk_hec

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=elasticsearch>

\n
\n

object

\n

The Elasticsearch destination.

\n
\n
\n
\n
\n
\n

auth [required]

\n
\n

object

\n

Basic access authentication.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

\n

Basic access authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

endpoint [required]

\n
\n

string

\n

The destination for which logs will be forwarded to.\nMust have HTTPS scheme and forwarding back to Datadog is not allowed.

\n
\n \n
\n
\n
\n
\n
\n

index_name [required]

\n
\n

string

\n

Name of the Elasticsearch index (must follow Elasticsearch's criteria).

\n
\n \n
\n
\n
\n
\n
\n

index_rotation

\n
\n

string

\n

Date pattern with US locale and UTC timezone to be appended to the index name after adding -\n(that is, ${index_name}-${indexPattern}).\nYou can customize the index rotation naming pattern by choosing one of these options:

\n
    \n
  • Hourly: yyyy-MM-dd-HH (as an example, it would render: 2022-10-19-09)
    • \n
  • Daily: yyyy-MM-dd (as an example, it would render: 2022-10-19)
    • \n
  • Weekly: yyyy-'W'ww (as an example, it would render: 2022-W42)
    • \n
  • Monthly: yyyy-MM (as an example, it would render: 2022-10)
    • \n
\n

If this field is missing or is blank, it means that the index name will always be the same\n(that is, no rotation).

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the Elasticsearch destination. \nAllowed enum values: elasticsearch

default: elasticsearch

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=microsoft_sentinel>

\n
\n

object

\n

The Microsoft Sentinel destination.

\n
\n
\n
\n
\n
\n

client_id [required]

\n
\n

string

\n

Client ID from the Datadog Azure integration.

\n
\n \n
\n
\n
\n
\n
\n

data_collection_endpoint [required]

\n
\n

string

\n

Azure data collection endpoint.

\n
\n \n
\n
\n
\n
\n
\n

data_collection_rule_id [required]

\n
\n

string

\n

Azure data collection rule ID.

\n
\n \n
\n
\n
\n
\n
\n

stream_name [required]

\n
\n

string

\n

Azure stream name.

\n
\n \n
\n
\n
\n
\n
\n

tenant_id [required]

\n
\n

string

\n

Tenant ID from the Datadog Azure integration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the Microsoft Sentinel destination. \nAllowed enum values: microsoft_sentinel

default: microsoft_sentinel

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The custom destination name.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The custom destination query filter. Logs matching this query are forwarded to the destination.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The custom destination ID.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the resource. The value should always be custom_destination. \nAllowed enum values: custom_destination

default: custom_destination

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

A list of custom destinations.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes associated with the custom destination.

\n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether logs matching this custom destination should be forwarded or not.

default: true

\n
\n \n
\n
\n
\n
\n
\n

forward_tags

\n
\n

boolean

\n

Whether tags from the forwarded logs should be forwarded or not.

default: true

\n
\n \n
\n
\n
\n
\n
\n

forward_tags_restriction_list

\n
\n

[string]

\n

List of keys of tags to be filtered.

An empty list represents no restriction is in place and either all or no tags will be\nforwarded depending on forward_tags_restriction_list_type parameter.

default:

\n
\n \n
\n
\n
\n
\n
\n

forward_tags_restriction_list_type

\n
\n

enum

\n

How forward_tags_restriction_list parameter should be interpreted.\nIf ALLOW_LIST, then only tags whose keys on the forwarded logs match the ones on the restriction list\nare forwarded.

BLOCK_LIST works the opposite way. It does not forward the tags matching the ones on the list. \nAllowed enum values: ALLOW_LIST,BLOCK_LIST

default: ALLOW_LIST

\n
\n \n
\n
\n
\n
\n
\n

forwarder_destination

\n
\n

 <oneOf>

\n

A custom destination's location to forward logs.

\n
\n
\n
\n
\n
\n

<type=http>

\n
\n

object

\n

The HTTP destination.

\n
\n
\n
\n
\n
\n

auth [required]

\n
\n

 <oneOf>

\n

Authentication method of the HTTP requests.

\n
\n
\n
\n
\n
\n

<type=basic>

\n
\n

object

\n

Basic access authentication.

\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the basic access authentication. \nAllowed enum values: basic

default: basic

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=custom_header>

\n
\n

object

\n

Custom header access authentication.

\n
\n
\n
\n
\n
\n

header_name [required]

\n
\n

string

\n

The header name of the authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the custom header access authentication. \nAllowed enum values: custom_header

default: custom_header

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

endpoint [required]

\n
\n

string

\n

The destination for which logs will be forwarded to.\nMust have HTTPS scheme and forwarding back to Datadog is not allowed.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the HTTP destination. \nAllowed enum values: http

default: http

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=splunk_hec>

\n
\n

object

\n

The Splunk HTTP Event Collector (HEC) destination.

\n
\n
\n
\n
\n
\n

endpoint [required]

\n
\n

string

\n

The destination for which logs will be forwarded to.\nMust have HTTPS scheme and forwarding back to Datadog is not allowed.

\n
\n \n
\n
\n
\n
\n
\n

sourcetype

\n
\n

string

\n

The Splunk sourcetype for the events sent to this Splunk destination.

If the field is absent from the request and no sourcetype has been previously set on this destination, the default sourcetype _json is used.\nOn update, if the field is absent from the request but a sourcetype was previously set, the previous value is kept.\nIf set to null, the sourcetype field is omitted from the forwarded event entirely.\nOtherwise, the provided string value is used as the sourcetype.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the Splunk HTTP Event Collector (HEC) destination. \nAllowed enum values: splunk_hec

default: splunk_hec

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=elasticsearch>

\n
\n

object

\n

The Elasticsearch destination.

\n
\n
\n
\n
\n
\n

auth [required]

\n
\n

object

\n

Basic access authentication.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

\n

Basic access authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

endpoint [required]

\n
\n

string

\n

The destination for which logs will be forwarded to.\nMust have HTTPS scheme and forwarding back to Datadog is not allowed.

\n
\n \n
\n
\n
\n
\n
\n

index_name [required]

\n
\n

string

\n

Name of the Elasticsearch index (must follow Elasticsearch's criteria).

\n
\n \n
\n
\n
\n
\n
\n

index_rotation

\n
\n

string

\n

Date pattern with US locale and UTC timezone to be appended to the index name after adding -\n(that is, ${index_name}-${indexPattern}).\nYou can customize the index rotation naming pattern by choosing one of these options:

\n
    \n
  • Hourly: yyyy-MM-dd-HH (as an example, it would render: 2022-10-19-09)
    • \n
  • Daily: yyyy-MM-dd (as an example, it would render: 2022-10-19)
    • \n
  • Weekly: yyyy-'W'ww (as an example, it would render: 2022-W42)
    • \n
  • Monthly: yyyy-MM (as an example, it would render: 2022-10)
    • \n
\n

If this field is missing or is blank, it means that the index name will always be the same\n(that is, no rotation).

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the Elasticsearch destination. \nAllowed enum values: elasticsearch

default: elasticsearch

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=microsoft_sentinel>

\n
\n

object

\n

The Microsoft Sentinel destination.

\n
\n
\n
\n
\n
\n

client_id [required]

\n
\n

string

\n

Client ID from the Datadog Azure integration.

\n
\n \n
\n
\n
\n
\n
\n

data_collection_endpoint [required]

\n
\n

string

\n

Azure data collection endpoint.

\n
\n \n
\n
\n
\n
\n
\n

data_collection_rule_id [required]

\n
\n

string

\n

Azure data collection rule ID.

\n
\n \n
\n
\n
\n
\n
\n

tenant_id [required]

\n
\n

string

\n

Tenant ID from the Datadog Azure integration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the Microsoft Sentinel destination. \nAllowed enum values: microsoft_sentinel

default: microsoft_sentinel

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The custom destination name.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The custom destination query filter. Logs matching this query are forwarded to the destination.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The custom destination ID.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the resource. The value should always be custom_destination. \nAllowed enum values: custom_destination

default: custom_destination

\n
\n \n
\n
\n
\n
" }, "403": { "json": { @@ -80,7 +80,7 @@ "type": "custom_destination" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of a custom destination.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes associated with the custom destination.

\n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether logs matching this custom destination should be forwarded or not.

default: true

\n
\n \n
\n
\n
\n
\n
\n

forward_tags

\n
\n

boolean

\n

Whether tags from the forwarded logs should be forwarded or not.

default: true

\n
\n \n
\n
\n
\n
\n
\n

forward_tags_restriction_list

\n
\n

[string]

\n

List of keys of tags to be filtered.

An empty list represents no restriction is in place and either all or no tags will be\nforwarded depending on forward_tags_restriction_list_type parameter.

default:

\n
\n \n
\n
\n
\n
\n
\n

forward_tags_restriction_list_type

\n
\n

enum

\n

How forward_tags_restriction_list parameter should be interpreted.\nIf ALLOW_LIST, then only tags whose keys on the forwarded logs match the ones on the restriction list\nare forwarded.

BLOCK_LIST works the opposite way. It does not forward the tags matching the ones on the list. \nAllowed enum values: ALLOW_LIST,BLOCK_LIST

default: ALLOW_LIST

\n
\n \n
\n
\n
\n
\n
\n

forwarder_destination

\n
\n

 <oneOf>

\n

A custom destination's location to forward logs.

\n
\n
\n
\n
\n
\n

<type=http>

\n
\n

object

\n

The HTTP destination.

\n
\n
\n
\n
\n
\n

auth [required]

\n
\n

 <oneOf>

\n

Authentication method of the HTTP requests.

\n
\n
\n
\n
\n
\n

<type=basic>

\n
\n

object

\n

Basic access authentication.

\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the basic access authentication. \nAllowed enum values: basic

default: basic

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=custom_header>

\n
\n

object

\n

Custom header access authentication.

\n
\n
\n
\n
\n
\n

header_name [required]

\n
\n

string

\n

The header name of the authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the custom header access authentication. \nAllowed enum values: custom_header

default: custom_header

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

endpoint [required]

\n
\n

string

\n

The destination for which logs will be forwarded to.\nMust have HTTPS scheme and forwarding back to Datadog is not allowed.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the HTTP destination. \nAllowed enum values: http

default: http

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=splunk_hec>

\n
\n

object

\n

The Splunk HTTP Event Collector (HEC) destination.

\n
\n
\n
\n
\n
\n

endpoint [required]

\n
\n

string

\n

The destination for which logs will be forwarded to.\nMust have HTTPS scheme and forwarding back to Datadog is not allowed.

\n
\n \n
\n
\n
\n
\n
\n

sourcetype

\n
\n

string

\n

The Splunk sourcetype for the events sent to this Splunk destination.

If the field is absent from the request and no sourcetype has been previously set on this destination, the default sourcetype _json is used.\nOn update, if the field is absent from the request but a sourcetype was previously set, the previous value is kept.\nIf set to null, the sourcetype field is omitted from the forwarded event entirely.\nOtherwise, the provided string value is used as the sourcetype.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the Splunk HTTP Event Collector (HEC) destination. \nAllowed enum values: splunk_hec

default: splunk_hec

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=elasticsearch>

\n
\n

object

\n

The Elasticsearch destination.

\n
\n
\n
\n
\n
\n

auth [required]

\n
\n

object

\n

Basic access authentication.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

\n

Basic access authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

endpoint [required]

\n
\n

string

\n

The destination for which logs will be forwarded to.\nMust have HTTPS scheme and forwarding back to Datadog is not allowed.

\n
\n \n
\n
\n
\n
\n
\n

index_name [required]

\n
\n

string

\n

Name of the Elasticsearch index (must follow Elasticsearch's criteria).

\n
\n \n
\n
\n
\n
\n
\n

index_rotation

\n
\n

string

\n

Date pattern with US locale and UTC timezone to be appended to the index name after adding -\n(that is, ${index_name}-${indexPattern}).\nYou can customize the index rotation naming pattern by choosing one of these options:

\n
    \n
  • Hourly: yyyy-MM-dd-HH (as an example, it would render: 2022-10-19-09)
    • \n
  • Daily: yyyy-MM-dd (as an example, it would render: 2022-10-19)
    • \n
  • Weekly: yyyy-'W'ww (as an example, it would render: 2022-W42)
    • \n
  • Monthly: yyyy-MM (as an example, it would render: 2022-10)
    • \n
\n

If this field is missing or is blank, it means that the index name will always be the same\n(that is, no rotation).

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the Elasticsearch destination. \nAllowed enum values: elasticsearch

default: elasticsearch

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=microsoft_sentinel>

\n
\n

object

\n

The Microsoft Sentinel destination.

\n
\n
\n
\n
\n
\n

client_id [required]

\n
\n

string

\n

Client ID from the Datadog Azure integration.

\n
\n \n
\n
\n
\n
\n
\n

data_collection_endpoint [required]

\n
\n

string

\n

Azure data collection endpoint.

\n
\n \n
\n
\n
\n
\n
\n

data_collection_rule_id [required]

\n
\n

string

\n

Azure data collection rule ID.

\n
\n \n
\n
\n
\n
\n
\n

stream_name [required]

\n
\n

string

\n

Azure stream name.

\n
\n \n
\n
\n
\n
\n
\n

tenant_id [required]

\n
\n

string

\n

Tenant ID from the Datadog Azure integration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the Microsoft Sentinel destination. \nAllowed enum values: microsoft_sentinel

default: microsoft_sentinel

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The custom destination name.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The custom destination query filter. Logs matching this query are forwarded to the destination.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The custom destination ID.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the resource. The value should always be custom_destination. \nAllowed enum values: custom_destination

default: custom_destination

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of a custom destination.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes associated with the custom destination.

\n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether logs matching this custom destination should be forwarded or not.

default: true

\n
\n \n
\n
\n
\n
\n
\n

forward_tags

\n
\n

boolean

\n

Whether tags from the forwarded logs should be forwarded or not.

default: true

\n
\n \n
\n
\n
\n
\n
\n

forward_tags_restriction_list

\n
\n

[string]

\n

List of keys of tags to be filtered.

An empty list represents no restriction is in place and either all or no tags will be\nforwarded depending on forward_tags_restriction_list_type parameter.

default:

\n
\n \n
\n
\n
\n
\n
\n

forward_tags_restriction_list_type

\n
\n

enum

\n

How forward_tags_restriction_list parameter should be interpreted.\nIf ALLOW_LIST, then only tags whose keys on the forwarded logs match the ones on the restriction list\nare forwarded.

BLOCK_LIST works the opposite way. It does not forward the tags matching the ones on the list. \nAllowed enum values: ALLOW_LIST,BLOCK_LIST

default: ALLOW_LIST

\n
\n \n
\n
\n
\n
\n
\n

forwarder_destination

\n
\n

 <oneOf>

\n

A custom destination's location to forward logs.

\n
\n
\n
\n
\n
\n

<type=http>

\n
\n

object

\n

The HTTP destination.

\n
\n
\n
\n
\n
\n

auth [required]

\n
\n

 <oneOf>

\n

Authentication method of the HTTP requests.

\n
\n
\n
\n
\n
\n

<type=basic>

\n
\n

object

\n

Basic access authentication.

\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the basic access authentication. \nAllowed enum values: basic

default: basic

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=custom_header>

\n
\n

object

\n

Custom header access authentication.

\n
\n
\n
\n
\n
\n

header_name [required]

\n
\n

string

\n

The header name of the authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the custom header access authentication. \nAllowed enum values: custom_header

default: custom_header

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

endpoint [required]

\n
\n

string

\n

The destination for which logs will be forwarded to.\nMust have HTTPS scheme and forwarding back to Datadog is not allowed.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the HTTP destination. \nAllowed enum values: http

default: http

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=splunk_hec>

\n
\n

object

\n

The Splunk HTTP Event Collector (HEC) destination.

\n
\n
\n
\n
\n
\n

endpoint [required]

\n
\n

string

\n

The destination for which logs will be forwarded to.\nMust have HTTPS scheme and forwarding back to Datadog is not allowed.

\n
\n \n
\n
\n
\n
\n
\n

sourcetype

\n
\n

string

\n

The Splunk sourcetype for the events sent to this Splunk destination.

If the field is absent from the request and no sourcetype has been previously set on this destination, the default sourcetype _json is used.\nOn update, if the field is absent from the request but a sourcetype was previously set, the previous value is kept.\nIf set to null, the sourcetype field is omitted from the forwarded event entirely.\nOtherwise, the provided string value is used as the sourcetype.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the Splunk HTTP Event Collector (HEC) destination. \nAllowed enum values: splunk_hec

default: splunk_hec

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=elasticsearch>

\n
\n

object

\n

The Elasticsearch destination.

\n
\n
\n
\n
\n
\n

auth [required]

\n
\n

object

\n

Basic access authentication.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

\n

Basic access authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

endpoint [required]

\n
\n

string

\n

The destination for which logs will be forwarded to.\nMust have HTTPS scheme and forwarding back to Datadog is not allowed.

\n
\n \n
\n
\n
\n
\n
\n

index_name [required]

\n
\n

string

\n

Name of the Elasticsearch index (must follow Elasticsearch's criteria).

\n
\n \n
\n
\n
\n
\n
\n

index_rotation

\n
\n

string

\n

Date pattern with US locale and UTC timezone to be appended to the index name after adding -\n(that is, ${index_name}-${indexPattern}).\nYou can customize the index rotation naming pattern by choosing one of these options:

\n
    \n
  • Hourly: yyyy-MM-dd-HH (as an example, it would render: 2022-10-19-09)
    • \n
  • Daily: yyyy-MM-dd (as an example, it would render: 2022-10-19)
    • \n
  • Weekly: yyyy-'W'ww (as an example, it would render: 2022-W42)
    • \n
  • Monthly: yyyy-MM (as an example, it would render: 2022-10)
    • \n
\n

If this field is missing or is blank, it means that the index name will always be the same\n(that is, no rotation).

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the Elasticsearch destination. \nAllowed enum values: elasticsearch

default: elasticsearch

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=microsoft_sentinel>

\n
\n

object

\n

The Microsoft Sentinel destination.

\n
\n
\n
\n
\n
\n

client_id [required]

\n
\n

string

\n

Client ID from the Datadog Azure integration.

\n
\n \n
\n
\n
\n
\n
\n

data_collection_endpoint [required]

\n
\n

string

\n

Azure data collection endpoint.

\n
\n \n
\n
\n
\n
\n
\n

data_collection_rule_id [required]

\n
\n

string

\n

Azure data collection rule ID.

\n
\n \n
\n
\n
\n
\n
\n

tenant_id [required]

\n
\n

string

\n

Tenant ID from the Datadog Azure integration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the Microsoft Sentinel destination. \nAllowed enum values: microsoft_sentinel

default: microsoft_sentinel

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The custom destination name.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The custom destination query filter. Logs matching this query are forwarded to the destination.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The custom destination ID.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the resource. The value should always be custom_destination. \nAllowed enum values: custom_destination

default: custom_destination

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -221,7 +221,7 @@ "type": "custom_destination" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of a custom destination.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes associated with the custom destination.

\n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether logs matching this custom destination should be forwarded or not.

default: true

\n
\n \n
\n
\n
\n
\n
\n

forward_tags

\n
\n

boolean

\n

Whether tags from the forwarded logs should be forwarded or not.

default: true

\n
\n \n
\n
\n
\n
\n
\n

forward_tags_restriction_list

\n
\n

[string]

\n

List of keys of tags to be filtered.

An empty list represents no restriction is in place and either all or no tags will be\nforwarded depending on forward_tags_restriction_list_type parameter.

default:

\n
\n \n
\n
\n
\n
\n
\n

forward_tags_restriction_list_type

\n
\n

enum

\n

How forward_tags_restriction_list parameter should be interpreted.\nIf ALLOW_LIST, then only tags whose keys on the forwarded logs match the ones on the restriction list\nare forwarded.

BLOCK_LIST works the opposite way. It does not forward the tags matching the ones on the list. \nAllowed enum values: ALLOW_LIST,BLOCK_LIST

default: ALLOW_LIST

\n
\n \n
\n
\n
\n
\n
\n

forwarder_destination

\n
\n

 <oneOf>

\n

A custom destination's location to forward logs.

\n
\n
\n
\n
\n
\n

<type=http>

\n
\n

object

\n

The HTTP destination.

\n
\n
\n
\n
\n
\n

auth [required]

\n
\n

 <oneOf>

\n

Authentication method of the HTTP requests.

\n
\n
\n
\n
\n
\n

<type=basic>

\n
\n

object

\n

Basic access authentication.

\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the basic access authentication. \nAllowed enum values: basic

default: basic

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=custom_header>

\n
\n

object

\n

Custom header access authentication.

\n
\n
\n
\n
\n
\n

header_name [required]

\n
\n

string

\n

The header name of the authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the custom header access authentication. \nAllowed enum values: custom_header

default: custom_header

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

endpoint [required]

\n
\n

string

\n

The destination for which logs will be forwarded to.\nMust have HTTPS scheme and forwarding back to Datadog is not allowed.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the HTTP destination. \nAllowed enum values: http

default: http

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=splunk_hec>

\n
\n

object

\n

The Splunk HTTP Event Collector (HEC) destination.

\n
\n
\n
\n
\n
\n

endpoint [required]

\n
\n

string

\n

The destination for which logs will be forwarded to.\nMust have HTTPS scheme and forwarding back to Datadog is not allowed.

\n
\n \n
\n
\n
\n
\n
\n

sourcetype

\n
\n

string

\n

The Splunk sourcetype for the events sent to this Splunk destination.

If the field is absent from the request and no sourcetype has been previously set on this destination, the default sourcetype _json is used.\nOn update, if the field is absent from the request but a sourcetype was previously set, the previous value is kept.\nIf set to null, the sourcetype field is omitted from the forwarded event entirely.\nOtherwise, the provided string value is used as the sourcetype.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the Splunk HTTP Event Collector (HEC) destination. \nAllowed enum values: splunk_hec

default: splunk_hec

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=elasticsearch>

\n
\n

object

\n

The Elasticsearch destination.

\n
\n
\n
\n
\n
\n

auth [required]

\n
\n

object

\n

Basic access authentication.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

\n

Basic access authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

endpoint [required]

\n
\n

string

\n

The destination for which logs will be forwarded to.\nMust have HTTPS scheme and forwarding back to Datadog is not allowed.

\n
\n \n
\n
\n
\n
\n
\n

index_name [required]

\n
\n

string

\n

Name of the Elasticsearch index (must follow Elasticsearch's criteria).

\n
\n \n
\n
\n
\n
\n
\n

index_rotation

\n
\n

string

\n

Date pattern with US locale and UTC timezone to be appended to the index name after adding -\n(that is, ${index_name}-${indexPattern}).\nYou can customize the index rotation naming pattern by choosing one of these options:

\n
    \n
  • Hourly: yyyy-MM-dd-HH (as an example, it would render: 2022-10-19-09)
    • \n
  • Daily: yyyy-MM-dd (as an example, it would render: 2022-10-19)
    • \n
  • Weekly: yyyy-'W'ww (as an example, it would render: 2022-W42)
    • \n
  • Monthly: yyyy-MM (as an example, it would render: 2022-10)
    • \n
\n

If this field is missing or is blank, it means that the index name will always be the same\n(that is, no rotation).

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the Elasticsearch destination. \nAllowed enum values: elasticsearch

default: elasticsearch

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=microsoft_sentinel>

\n
\n

object

\n

The Microsoft Sentinel destination.

\n
\n
\n
\n
\n
\n

client_id [required]

\n
\n

string

\n

Client ID from the Datadog Azure integration.

\n
\n \n
\n
\n
\n
\n
\n

data_collection_endpoint [required]

\n
\n

string

\n

Azure data collection endpoint.

\n
\n \n
\n
\n
\n
\n
\n

data_collection_rule_id [required]

\n
\n

string

\n

Azure data collection rule ID.

\n
\n \n
\n
\n
\n
\n
\n

stream_name [required]

\n
\n

string

\n

Azure stream name.

\n
\n \n
\n
\n
\n
\n
\n

tenant_id [required]

\n
\n

string

\n

Tenant ID from the Datadog Azure integration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the Microsoft Sentinel destination. \nAllowed enum values: microsoft_sentinel

default: microsoft_sentinel

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The custom destination name.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The custom destination query filter. Logs matching this query are forwarded to the destination.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The custom destination ID.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the resource. The value should always be custom_destination. \nAllowed enum values: custom_destination

default: custom_destination

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of a custom destination.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes associated with the custom destination.

\n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether logs matching this custom destination should be forwarded or not.

default: true

\n
\n \n
\n
\n
\n
\n
\n

forward_tags

\n
\n

boolean

\n

Whether tags from the forwarded logs should be forwarded or not.

default: true

\n
\n \n
\n
\n
\n
\n
\n

forward_tags_restriction_list

\n
\n

[string]

\n

List of keys of tags to be filtered.

An empty list represents no restriction is in place and either all or no tags will be\nforwarded depending on forward_tags_restriction_list_type parameter.

default:

\n
\n \n
\n
\n
\n
\n
\n

forward_tags_restriction_list_type

\n
\n

enum

\n

How forward_tags_restriction_list parameter should be interpreted.\nIf ALLOW_LIST, then only tags whose keys on the forwarded logs match the ones on the restriction list\nare forwarded.

BLOCK_LIST works the opposite way. It does not forward the tags matching the ones on the list. \nAllowed enum values: ALLOW_LIST,BLOCK_LIST

default: ALLOW_LIST

\n
\n \n
\n
\n
\n
\n
\n

forwarder_destination

\n
\n

 <oneOf>

\n

A custom destination's location to forward logs.

\n
\n
\n
\n
\n
\n

<type=http>

\n
\n

object

\n

The HTTP destination.

\n
\n
\n
\n
\n
\n

auth [required]

\n
\n

 <oneOf>

\n

Authentication method of the HTTP requests.

\n
\n
\n
\n
\n
\n

<type=basic>

\n
\n

object

\n

Basic access authentication.

\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the basic access authentication. \nAllowed enum values: basic

default: basic

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=custom_header>

\n
\n

object

\n

Custom header access authentication.

\n
\n
\n
\n
\n
\n

header_name [required]

\n
\n

string

\n

The header name of the authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the custom header access authentication. \nAllowed enum values: custom_header

default: custom_header

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

endpoint [required]

\n
\n

string

\n

The destination for which logs will be forwarded to.\nMust have HTTPS scheme and forwarding back to Datadog is not allowed.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the HTTP destination. \nAllowed enum values: http

default: http

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=splunk_hec>

\n
\n

object

\n

The Splunk HTTP Event Collector (HEC) destination.

\n
\n
\n
\n
\n
\n

endpoint [required]

\n
\n

string

\n

The destination for which logs will be forwarded to.\nMust have HTTPS scheme and forwarding back to Datadog is not allowed.

\n
\n \n
\n
\n
\n
\n
\n

sourcetype

\n
\n

string

\n

The Splunk sourcetype for the events sent to this Splunk destination.

If the field is absent from the request and no sourcetype has been previously set on this destination, the default sourcetype _json is used.\nOn update, if the field is absent from the request but a sourcetype was previously set, the previous value is kept.\nIf set to null, the sourcetype field is omitted from the forwarded event entirely.\nOtherwise, the provided string value is used as the sourcetype.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the Splunk HTTP Event Collector (HEC) destination. \nAllowed enum values: splunk_hec

default: splunk_hec

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=elasticsearch>

\n
\n

object

\n

The Elasticsearch destination.

\n
\n
\n
\n
\n
\n

auth [required]

\n
\n

object

\n

Basic access authentication.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

\n

Basic access authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

endpoint [required]

\n
\n

string

\n

The destination for which logs will be forwarded to.\nMust have HTTPS scheme and forwarding back to Datadog is not allowed.

\n
\n \n
\n
\n
\n
\n
\n

index_name [required]

\n
\n

string

\n

Name of the Elasticsearch index (must follow Elasticsearch's criteria).

\n
\n \n
\n
\n
\n
\n
\n

index_rotation

\n
\n

string

\n

Date pattern with US locale and UTC timezone to be appended to the index name after adding -\n(that is, ${index_name}-${indexPattern}).\nYou can customize the index rotation naming pattern by choosing one of these options:

\n
    \n
  • Hourly: yyyy-MM-dd-HH (as an example, it would render: 2022-10-19-09)
    • \n
  • Daily: yyyy-MM-dd (as an example, it would render: 2022-10-19)
    • \n
  • Weekly: yyyy-'W'ww (as an example, it would render: 2022-W42)
    • \n
  • Monthly: yyyy-MM (as an example, it would render: 2022-10)
    • \n
\n

If this field is missing or is blank, it means that the index name will always be the same\n(that is, no rotation).

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the Elasticsearch destination. \nAllowed enum values: elasticsearch

default: elasticsearch

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=microsoft_sentinel>

\n
\n

object

\n

The Microsoft Sentinel destination.

\n
\n
\n
\n
\n
\n

client_id [required]

\n
\n

string

\n

Client ID from the Datadog Azure integration.

\n
\n \n
\n
\n
\n
\n
\n

data_collection_endpoint [required]

\n
\n

string

\n

Azure data collection endpoint.

\n
\n \n
\n
\n
\n
\n
\n

data_collection_rule_id [required]

\n
\n

string

\n

Azure data collection rule ID.

\n
\n \n
\n
\n
\n
\n
\n

tenant_id [required]

\n
\n

string

\n

Tenant ID from the Datadog Azure integration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the Microsoft Sentinel destination. \nAllowed enum values: microsoft_sentinel

default: microsoft_sentinel

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The custom destination name.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The custom destination query filter. Logs matching this query are forwarded to the destination.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The custom destination ID.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the resource. The value should always be custom_destination. \nAllowed enum values: custom_destination

default: custom_destination

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -289,7 +289,7 @@ "type": "custom_destination" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of a custom destination.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes associated with the custom destination.

\n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether logs matching this custom destination should be forwarded or not.

default: true

\n
\n \n
\n
\n
\n
\n
\n

forward_tags

\n
\n

boolean

\n

Whether tags from the forwarded logs should be forwarded or not.

default: true

\n
\n \n
\n
\n
\n
\n
\n

forward_tags_restriction_list

\n
\n

[string]

\n

List of keys of tags to be filtered.

An empty list represents no restriction is in place and either all or no tags will be\nforwarded depending on forward_tags_restriction_list_type parameter.

default:

\n
\n \n
\n
\n
\n
\n
\n

forward_tags_restriction_list_type

\n
\n

enum

\n

How forward_tags_restriction_list parameter should be interpreted.\nIf ALLOW_LIST, then only tags whose keys on the forwarded logs match the ones on the restriction list\nare forwarded.

BLOCK_LIST works the opposite way. It does not forward the tags matching the ones on the list. \nAllowed enum values: ALLOW_LIST,BLOCK_LIST

default: ALLOW_LIST

\n
\n \n
\n
\n
\n
\n
\n

forwarder_destination

\n
\n

 <oneOf>

\n

A custom destination's location to forward logs.

\n
\n
\n
\n
\n
\n

<type=http>

\n
\n

object

\n

The HTTP destination.

\n
\n
\n
\n
\n
\n

auth [required]

\n
\n

 <oneOf>

\n

Authentication method of the HTTP requests.

\n
\n
\n
\n
\n
\n

<type=basic>

\n
\n

object

\n

Basic access authentication.

\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the basic access authentication. \nAllowed enum values: basic

default: basic

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=custom_header>

\n
\n

object

\n

Custom header access authentication.

\n
\n
\n
\n
\n
\n

header_name [required]

\n
\n

string

\n

The header name of the authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the custom header access authentication. \nAllowed enum values: custom_header

default: custom_header

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

endpoint [required]

\n
\n

string

\n

The destination for which logs will be forwarded to.\nMust have HTTPS scheme and forwarding back to Datadog is not allowed.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the HTTP destination. \nAllowed enum values: http

default: http

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=splunk_hec>

\n
\n

object

\n

The Splunk HTTP Event Collector (HEC) destination.

\n
\n
\n
\n
\n
\n

endpoint [required]

\n
\n

string

\n

The destination for which logs will be forwarded to.\nMust have HTTPS scheme and forwarding back to Datadog is not allowed.

\n
\n \n
\n
\n
\n
\n
\n

sourcetype

\n
\n

string

\n

The Splunk sourcetype for the events sent to this Splunk destination.

If the field is absent from the request and no sourcetype has been previously set on this destination, the default sourcetype _json is used.\nOn update, if the field is absent from the request but a sourcetype was previously set, the previous value is kept.\nIf set to null, the sourcetype field is omitted from the forwarded event entirely.\nOtherwise, the provided string value is used as the sourcetype.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the Splunk HTTP Event Collector (HEC) destination. \nAllowed enum values: splunk_hec

default: splunk_hec

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=elasticsearch>

\n
\n

object

\n

The Elasticsearch destination.

\n
\n
\n
\n
\n
\n

auth [required]

\n
\n

object

\n

Basic access authentication.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

\n

Basic access authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

endpoint [required]

\n
\n

string

\n

The destination for which logs will be forwarded to.\nMust have HTTPS scheme and forwarding back to Datadog is not allowed.

\n
\n \n
\n
\n
\n
\n
\n

index_name [required]

\n
\n

string

\n

Name of the Elasticsearch index (must follow Elasticsearch's criteria).

\n
\n \n
\n
\n
\n
\n
\n

index_rotation

\n
\n

string

\n

Date pattern with US locale and UTC timezone to be appended to the index name after adding -\n(that is, ${index_name}-${indexPattern}).\nYou can customize the index rotation naming pattern by choosing one of these options:

\n
    \n
  • Hourly: yyyy-MM-dd-HH (as an example, it would render: 2022-10-19-09)
    • \n
  • Daily: yyyy-MM-dd (as an example, it would render: 2022-10-19)
    • \n
  • Weekly: yyyy-'W'ww (as an example, it would render: 2022-W42)
    • \n
  • Monthly: yyyy-MM (as an example, it would render: 2022-10)
    • \n
\n

If this field is missing or is blank, it means that the index name will always be the same\n(that is, no rotation).

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the Elasticsearch destination. \nAllowed enum values: elasticsearch

default: elasticsearch

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=microsoft_sentinel>

\n
\n

object

\n

The Microsoft Sentinel destination.

\n
\n
\n
\n
\n
\n

client_id [required]

\n
\n

string

\n

Client ID from the Datadog Azure integration.

\n
\n \n
\n
\n
\n
\n
\n

data_collection_endpoint [required]

\n
\n

string

\n

Azure data collection endpoint.

\n
\n \n
\n
\n
\n
\n
\n

data_collection_rule_id [required]

\n
\n

string

\n

Azure data collection rule ID.

\n
\n \n
\n
\n
\n
\n
\n

stream_name [required]

\n
\n

string

\n

Azure stream name.

\n
\n \n
\n
\n
\n
\n
\n

tenant_id [required]

\n
\n

string

\n

Tenant ID from the Datadog Azure integration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the Microsoft Sentinel destination. \nAllowed enum values: microsoft_sentinel

default: microsoft_sentinel

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The custom destination name.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The custom destination query filter. Logs matching this query are forwarded to the destination.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The custom destination ID.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the resource. The value should always be custom_destination. \nAllowed enum values: custom_destination

default: custom_destination

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of a custom destination.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes associated with the custom destination.

\n
\n
\n
\n
\n
\n

enabled

\n
\n

boolean

\n

Whether logs matching this custom destination should be forwarded or not.

default: true

\n
\n \n
\n
\n
\n
\n
\n

forward_tags

\n
\n

boolean

\n

Whether tags from the forwarded logs should be forwarded or not.

default: true

\n
\n \n
\n
\n
\n
\n
\n

forward_tags_restriction_list

\n
\n

[string]

\n

List of keys of tags to be filtered.

An empty list represents no restriction is in place and either all or no tags will be\nforwarded depending on forward_tags_restriction_list_type parameter.

default:

\n
\n \n
\n
\n
\n
\n
\n

forward_tags_restriction_list_type

\n
\n

enum

\n

How forward_tags_restriction_list parameter should be interpreted.\nIf ALLOW_LIST, then only tags whose keys on the forwarded logs match the ones on the restriction list\nare forwarded.

BLOCK_LIST works the opposite way. It does not forward the tags matching the ones on the list. \nAllowed enum values: ALLOW_LIST,BLOCK_LIST

default: ALLOW_LIST

\n
\n \n
\n
\n
\n
\n
\n

forwarder_destination

\n
\n

 <oneOf>

\n

A custom destination's location to forward logs.

\n
\n
\n
\n
\n
\n

<type=http>

\n
\n

object

\n

The HTTP destination.

\n
\n
\n
\n
\n
\n

auth [required]

\n
\n

 <oneOf>

\n

Authentication method of the HTTP requests.

\n
\n
\n
\n
\n
\n

<type=basic>

\n
\n

object

\n

Basic access authentication.

\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the basic access authentication. \nAllowed enum values: basic

default: basic

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=custom_header>

\n
\n

object

\n

Custom header access authentication.

\n
\n
\n
\n
\n
\n

header_name [required]

\n
\n

string

\n

The header name of the authentication.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the custom header access authentication. \nAllowed enum values: custom_header

default: custom_header

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

endpoint [required]

\n
\n

string

\n

The destination for which logs will be forwarded to.\nMust have HTTPS scheme and forwarding back to Datadog is not allowed.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the HTTP destination. \nAllowed enum values: http

default: http

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=splunk_hec>

\n
\n

object

\n

The Splunk HTTP Event Collector (HEC) destination.

\n
\n
\n
\n
\n
\n

endpoint [required]

\n
\n

string

\n

The destination for which logs will be forwarded to.\nMust have HTTPS scheme and forwarding back to Datadog is not allowed.

\n
\n \n
\n
\n
\n
\n
\n

sourcetype

\n
\n

string

\n

The Splunk sourcetype for the events sent to this Splunk destination.

If the field is absent from the request and no sourcetype has been previously set on this destination, the default sourcetype _json is used.\nOn update, if the field is absent from the request but a sourcetype was previously set, the previous value is kept.\nIf set to null, the sourcetype field is omitted from the forwarded event entirely.\nOtherwise, the provided string value is used as the sourcetype.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the Splunk HTTP Event Collector (HEC) destination. \nAllowed enum values: splunk_hec

default: splunk_hec

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=elasticsearch>

\n
\n

object

\n

The Elasticsearch destination.

\n
\n
\n
\n
\n
\n

auth [required]

\n
\n

object

\n

Basic access authentication.

\n
\n
\n
\n
\n
\n

<any-key>

\n
\n

\n

Basic access authentication.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

endpoint [required]

\n
\n

string

\n

The destination for which logs will be forwarded to.\nMust have HTTPS scheme and forwarding back to Datadog is not allowed.

\n
\n \n
\n
\n
\n
\n
\n

index_name [required]

\n
\n

string

\n

Name of the Elasticsearch index (must follow Elasticsearch's criteria).

\n
\n \n
\n
\n
\n
\n
\n

index_rotation

\n
\n

string

\n

Date pattern with US locale and UTC timezone to be appended to the index name after adding -\n(that is, ${index_name}-${indexPattern}).\nYou can customize the index rotation naming pattern by choosing one of these options:

\n
    \n
  • Hourly: yyyy-MM-dd-HH (as an example, it would render: 2022-10-19-09)
    • \n
  • Daily: yyyy-MM-dd (as an example, it would render: 2022-10-19)
    • \n
  • Weekly: yyyy-'W'ww (as an example, it would render: 2022-W42)
    • \n
  • Monthly: yyyy-MM (as an example, it would render: 2022-10)
    • \n
\n

If this field is missing or is blank, it means that the index name will always be the same\n(that is, no rotation).

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the Elasticsearch destination. \nAllowed enum values: elasticsearch

default: elasticsearch

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=microsoft_sentinel>

\n
\n

object

\n

The Microsoft Sentinel destination.

\n
\n
\n
\n
\n
\n

client_id [required]

\n
\n

string

\n

Client ID from the Datadog Azure integration.

\n
\n \n
\n
\n
\n
\n
\n

data_collection_endpoint [required]

\n
\n

string

\n

Azure data collection endpoint.

\n
\n \n
\n
\n
\n
\n
\n

data_collection_rule_id [required]

\n
\n

string

\n

Azure data collection rule ID.

\n
\n \n
\n
\n
\n
\n
\n

tenant_id [required]

\n
\n

string

\n

Tenant ID from the Datadog Azure integration.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Type of the Microsoft Sentinel destination. \nAllowed enum values: microsoft_sentinel

default: microsoft_sentinel

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The custom destination name.

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

The custom destination query filter. Logs matching this query are forwarded to the destination.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The custom destination ID.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The type of the resource. The value should always be custom_destination. \nAllowed enum values: custom_destination

default: custom_destination

\n
\n \n
\n
\n
\n
" }, "400": { "json": { diff --git a/hugo/content/en/api/v2/okta-integration/examples.json b/hugo/content/en/api/v2/okta-integration/examples.json index 891b8f4365e..b63609d4a03 100644 --- a/hugo/content/en/api/v2/okta-integration/examples.json +++ b/hugo/content/en/api/v2/okta-integration/examples.json @@ -6,10 +6,8 @@ "data": [ { "attributes": { - "api_key": "string", "auth_method": "oauth", "client_id": "string", - "client_secret": "string", "domain": "https://example.okta.com/", "name": "Okta-Prod" }, @@ -18,7 +16,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

List of Okta accounts.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes object for an Okta account.

\n
\n
\n
\n
\n
\n

api_key

\n
\n

string

\n

The API key of the Okta account.

\n
\n \n
\n
\n
\n
\n
\n

auth_method [required]

\n
\n

string

\n

The authorization method for an Okta account.

\n
\n \n
\n
\n
\n
\n
\n

client_id

\n
\n

string

\n

The Client ID of an Okta app integration.

\n
\n \n
\n
\n
\n
\n
\n

client_secret

\n
\n

string

\n

The client secret of an Okta app integration.

\n
\n \n
\n
\n
\n
\n
\n

domain [required]

\n
\n

string

\n

The domain of the Okta account.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the Okta account.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Okta account, a UUID hash of the account name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Account type for an Okta account. \nAllowed enum values: okta-accounts

default: okta-accounts

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

List of Okta accounts.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes object for an Okta account.

\n
\n
\n
\n
\n
\n

auth_method [required]

\n
\n

string

\n

The authorization method for an Okta account.

\n
\n \n
\n
\n
\n
\n
\n

client_id

\n
\n

string

\n

The Client ID of an Okta app integration.

\n
\n \n
\n
\n
\n
\n
\n

domain [required]

\n
\n

string

\n

The domain of the Okta account.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the Okta account.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The ID of the Okta account, a UUID hash of the account name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Account type for an Okta account. \nAllowed enum values: okta-accounts

default: okta-accounts

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -65,10 +63,8 @@ "json": { "data": { "attributes": { - "api_key": "string", "auth_method": "oauth", "client_id": "string", - "client_secret": "string", "domain": "https://example.okta.com/", "name": "Okta-Prod" }, @@ -76,7 +72,7 @@ "type": "okta-accounts" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Schema for an Okta account.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes object for an Okta account.

\n
\n
\n
\n
\n
\n

api_key

\n
\n

string

\n

The API key of the Okta account.

\n
\n \n
\n
\n
\n
\n
\n

auth_method [required]

\n
\n

string

\n

The authorization method for an Okta account.

\n
\n \n
\n
\n
\n
\n
\n

client_id

\n
\n

string

\n

The Client ID of an Okta app integration.

\n
\n \n
\n
\n
\n
\n
\n

client_secret

\n
\n

string

\n

The client secret of an Okta app integration.

\n
\n \n
\n
\n
\n
\n
\n

domain [required]

\n
\n

string

\n

The domain of the Okta account.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the Okta account.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the Okta account, a UUID hash of the account name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Account type for an Okta account. \nAllowed enum values: okta-accounts

default: okta-accounts

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Schema for an Okta account.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes object for an Okta account.

\n
\n
\n
\n
\n
\n

auth_method [required]

\n
\n

string

\n

The authorization method for an Okta account.

\n
\n \n
\n
\n
\n
\n
\n

client_id

\n
\n

string

\n

The Client ID of an Okta app integration.

\n
\n \n
\n
\n
\n
\n
\n

domain [required]

\n
\n

string

\n

The domain of the Okta account.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the Okta account.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the Okta account, a UUID hash of the account name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Account type for an Okta account. \nAllowed enum values: okta-accounts

default: okta-accounts

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -186,10 +182,8 @@ "json": { "data": { "attributes": { - "api_key": "string", "auth_method": "oauth", "client_id": "string", - "client_secret": "string", "domain": "https://example.okta.com/", "name": "Okta-Prod" }, @@ -197,7 +191,7 @@ "type": "okta-accounts" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Schema for an Okta account.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes object for an Okta account.

\n
\n
\n
\n
\n
\n

api_key

\n
\n

string

\n

The API key of the Okta account.

\n
\n \n
\n
\n
\n
\n
\n

auth_method [required]

\n
\n

string

\n

The authorization method for an Okta account.

\n
\n \n
\n
\n
\n
\n
\n

client_id

\n
\n

string

\n

The Client ID of an Okta app integration.

\n
\n \n
\n
\n
\n
\n
\n

client_secret

\n
\n

string

\n

The client secret of an Okta app integration.

\n
\n \n
\n
\n
\n
\n
\n

domain [required]

\n
\n

string

\n

The domain of the Okta account.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the Okta account.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the Okta account, a UUID hash of the account name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Account type for an Okta account. \nAllowed enum values: okta-accounts

default: okta-accounts

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Schema for an Okta account.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes object for an Okta account.

\n
\n
\n
\n
\n
\n

auth_method [required]

\n
\n

string

\n

The authorization method for an Okta account.

\n
\n \n
\n
\n
\n
\n
\n

client_id

\n
\n

string

\n

The Client ID of an Okta app integration.

\n
\n \n
\n
\n
\n
\n
\n

domain [required]

\n
\n

string

\n

The domain of the Okta account.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the Okta account.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the Okta account, a UUID hash of the account name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Account type for an Okta account. \nAllowed enum values: okta-accounts

default: okta-accounts

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -244,10 +238,8 @@ "json": { "data": { "attributes": { - "api_key": "string", "auth_method": "oauth", "client_id": "string", - "client_secret": "string", "domain": "https://example.okta.com/", "name": "Okta-Prod" }, @@ -255,7 +247,7 @@ "type": "okta-accounts" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Schema for an Okta account.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes object for an Okta account.

\n
\n
\n
\n
\n
\n

api_key

\n
\n

string

\n

The API key of the Okta account.

\n
\n \n
\n
\n
\n
\n
\n

auth_method [required]

\n
\n

string

\n

The authorization method for an Okta account.

\n
\n \n
\n
\n
\n
\n
\n

client_id

\n
\n

string

\n

The Client ID of an Okta app integration.

\n
\n \n
\n
\n
\n
\n
\n

client_secret

\n
\n

string

\n

The client secret of an Okta app integration.

\n
\n \n
\n
\n
\n
\n
\n

domain [required]

\n
\n

string

\n

The domain of the Okta account.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the Okta account.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the Okta account, a UUID hash of the account name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Account type for an Okta account. \nAllowed enum values: okta-accounts

default: okta-accounts

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Schema for an Okta account.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes object for an Okta account.

\n
\n
\n
\n
\n
\n

auth_method [required]

\n
\n

string

\n

The authorization method for an Okta account.

\n
\n \n
\n
\n
\n
\n
\n

client_id

\n
\n

string

\n

The Client ID of an Okta app integration.

\n
\n \n
\n
\n
\n
\n
\n

domain [required]

\n
\n

string

\n

The domain of the Okta account.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The name of the Okta account.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the Okta account, a UUID hash of the account name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

Account type for an Okta account. \nAllowed enum values: okta-accounts

default: okta-accounts

\n
\n \n
\n
\n
\n
" }, "400": { "json": { diff --git a/hugo/content/en/api/v2/workflow-automation/examples.json b/hugo/content/en/api/v2/workflow-automation/examples.json index 61ce6b1d50f..e964984adb1 100644 --- a/hugo/content/en/api/v2/workflow-automation/examples.json +++ b/hugo/content/en/api/v2/workflow-automation/examples.json @@ -219,9 +219,6 @@ "description": "string", "name": "", "published": false, - "runAs": { - "type": "owner" - }, "runAsUserMode": "owner", "spec": { "annotations": [ @@ -355,8 +352,7 @@ ] }, "tags": [], - "updatedAt": "2019-09-19T10:00:00.000Z", - "webhookSecret": "string" + "updatedAt": "2019-09-19T10:00:00.000Z" }, "id": "string", "relationships": { @@ -382,7 +378,7 @@ "type": "workflows" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data related to the workflow.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The definition of WorkflowDataAttributes object.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

When the workflow was created.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

published

\n
\n

boolean

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

runAs

\n
\n

 <oneOf>

\n

Identity used to run the workflow.

\n
\n
\n
\n
\n
\n

<type=owner>

\n
\n

object

\n

Run the workflow as its owner.

\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The owner run-as type. \nAllowed enum values: owner

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=service_account>

\n
\n

object

\n

Run the workflow as a service account.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The service account identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The service account run-as type. \nAllowed enum values: service_account

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=initiator>

\n
\n

object

\n

Run the workflow as the user who initiates the execution.

\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The initiator run-as type. \nAllowed enum values: initiator

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

runAsUserMode

\n
\n

enum

\n

The effective type of identity used to run the workflow. \nAllowed enum values: owner,service_account,initiator

\n
\n \n
\n
\n
\n
\n
\n

spec [required]

\n
\n

object

\n

A complete Workflow Automation definition, including its triggers, steps, and connections.

\n
\n
\n
\n
\n
\n

annotations

\n
\n

[object]

\n

Up to 100 text annotations displayed on the workflow canvas.

\n
\n
\n
\n
\n
\n

display [required]

\n
\n

object

\n

The annotation's position and size on the workflow canvas.

\n
\n
\n
\n
\n
\n

bounds

\n
\n

object

\n

Canvas coordinates and dimensions for an annotation on the workflow canvas.

\n
\n
\n
\n
\n
\n

height

\n
\n

double

\n

The annotation's height on the canvas.

\n
\n \n
\n
\n
\n
\n
\n

width

\n
\n

double

\n

The annotation's width on the canvas.

\n
\n \n
\n
\n
\n
\n
\n

x

\n
\n

double

\n

The annotation's horizontal canvas coordinate.

\n
\n \n
\n
\n
\n
\n
\n

y

\n
\n

double

\n

The annotation's vertical canvas coordinate.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of this annotation within the workflow.

\n
\n \n
\n
\n
\n
\n
\n

markdownTextAnnotation [required]

\n
\n

object

\n

Markdown content displayed in an annotation.

\n
\n
\n
\n
\n
\n

text

\n
\n

string

\n

The annotation's Markdown content.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

connectionEnvs

\n
\n

[object]

\n

A list of connections or connection groups used in the workflow.

\n
\n
\n
\n
\n
\n

connectionGroups

\n
\n

[object]

\n

The ConnectionEnv connectionGroups.

\n
\n
\n
\n
\n
\n

connectionGroupId [required]

\n
\n

string

\n

The ConnectionGroup connectionGroupId.

\n
\n \n
\n
\n
\n
\n
\n

label [required]

\n
\n

string

\n

The ConnectionGroup label.

\n
\n \n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

The ConnectionGroup tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

connections

\n
\n

[object]

\n

The ConnectionEnv connections.

\n
\n
\n
\n
\n
\n

connectionId [required]

\n
\n

string

\n

The Connection connectionId.

\n
\n \n
\n
\n
\n
\n
\n

label [required]

\n
\n

string

\n

The Connection label.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

env [required]

\n
\n

enum

\n

The definition of ConnectionEnvEnv object. \nAllowed enum values: default

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Unique identifier used to trigger workflows automatically in Datadog.

\n
\n \n
\n
\n
\n
\n
\n

inputSchema

\n
\n

object

\n

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

\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

The InputSchema parameters.

\n
\n
\n
\n
\n
\n

allowExtraValues

\n
\n

boolean

\n

The InputSchemaParameters allowExtraValues.

\n
\n \n
\n
\n
\n
\n
\n

allowedValues

\n
\n

\n

The InputSchemaParameters allowedValues.

\n
\n \n
\n
\n
\n
\n
\n

defaultValue

\n
\n

\n

The InputSchemaParameters defaultValue.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The InputSchemaParameters description.

\n
\n \n
\n
\n
\n
\n
\n

label

\n
\n

string

\n

The InputSchemaParameters label.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The InputSchemaParameters name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of InputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

outputSchema

\n
\n

object

\n

A list of output parameters for the workflow.

\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

The OutputSchema parameters.

\n
\n
\n
\n
\n
\n

defaultValue

\n
\n

\n

The OutputSchemaParameters defaultValue.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The OutputSchemaParameters description.

\n
\n \n
\n
\n
\n
\n
\n

label

\n
\n

string

\n

The OutputSchemaParameters label.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The OutputSchemaParameters name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of OutputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

\n

The OutputSchemaParameters value.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

A Step is a sub-component of a workflow. Each Step performs an action.

\n
\n
\n
\n
\n
\n

actionId [required]

\n
\n

string

\n

The unique identifier of an action.

\n
\n \n
\n
\n
\n
\n
\n

completionGate

\n
\n

object

\n

Used to create conditions before running subsequent actions.

\n
\n
\n
\n
\n
\n

completionCondition [required]

\n
\n

object

\n

The definition of CompletionCondition object.

\n
\n
\n
\n
\n
\n

operand1 [required]

\n
\n

\n

The CompletionCondition operand1.

\n
\n \n
\n
\n
\n
\n
\n

operand2

\n
\n

\n

The CompletionCondition operand2.

\n
\n \n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

The definition of CompletionConditionOperator object. \nAllowed 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

Show 2 more,OPERATOR_IS_EMPTY,OPERATOR_IS_NOT_EMPTY

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

retryStrategy [required]

\n
\n

object

\n

The definition of RetryStrategy object.

\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR

\n
\n \n
\n
\n
\n
\n
\n

linear [required]

\n
\n

object

\n

The definition of RetryStrategyLinear object.

\n
\n
\n
\n
\n
\n

interval [required]

\n
\n

string

\n

The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n

maxRetries [required]

\n
\n

int32

\n

The RetryStrategyLinear maxRetries.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

connectionLabel

\n
\n

string

\n

The unique identifier of a connection defined in the spec.

\n
\n \n
\n
\n
\n
\n
\n

display

\n
\n

object

\n

The position of a step on the workflow canvas. Omit display from every step to use\nautomatic layout, or provide it for every step to preserve a manual layout.

\n
\n
\n
\n
\n
\n

bounds

\n
\n

object

\n

The definition of StepDisplayBounds object.

\n
\n
\n
\n
\n
\n

x

\n
\n

double

\n

The bounds x.

\n
\n \n
\n
\n
\n
\n
\n

y

\n
\n

double

\n

The bounds y.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

errorHandlers

\n
\n

[object]

\n

The Step errorHandlers.

\n
\n
\n
\n
\n
\n

fallbackStepName [required]

\n
\n

string

\n

The ErrorHandler fallbackStepName.

\n
\n \n
\n
\n
\n
\n
\n

retryStrategy [required]

\n
\n

object

\n

The definition of RetryStrategy object.

\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR

\n
\n \n
\n
\n
\n
\n
\n

linear [required]

\n
\n

object

\n

The definition of RetryStrategyLinear object.

\n
\n
\n
\n
\n
\n

interval [required]

\n
\n

string

\n

The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n

maxRetries [required]

\n
\n

int32

\n

The RetryStrategyLinear maxRetries.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the step.

\n
\n \n
\n
\n
\n
\n
\n

outboundEdges

\n
\n

[object]

\n

A list of subsequent actions to run. This list is empty for a terminal step.

\n
\n
\n
\n
\n
\n

branchName [required]

\n
\n

string

\n

The OutboundEdge branchName.

\n
\n \n
\n
\n
\n
\n
\n

nextStepName [required]

\n
\n

string

\n

The OutboundEdge nextStepName.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

A list of inputs for an action.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The Parameter name.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

\n

The Parameter value.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

readinessGate

\n
\n

object

\n

Used to merge multiple branches into a single branch.

\n
\n
\n
\n
\n
\n

thresholdType [required]

\n
\n

enum

\n

The definition of ReadinessGateThresholdType object. \nAllowed enum values: ANY,ALL

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

triggers

\n
\n

[ <oneOf>]

\n

The list of triggers that activate this workflow. At least one trigger is required, and each trigger type may appear at most once.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

Schema for an agent-based trigger.

\n
\n
\n
\n
\n
\n

agentTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Schema for an API-based trigger.

\n
\n
\n
\n
\n
\n

apiTrigger [required]

\n
\n

object

\n

Trigger a workflow from an API request. The workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 3

\n
\n

object

\n

Schema for an App-based trigger.

\n
\n
\n
\n
\n
\n

appTrigger [required]

\n
\n

object

\n

Trigger a workflow from an App.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 4

\n
\n

object

\n

Schema for a Case-based trigger.

\n
\n
\n
\n
\n
\n

caseTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Case. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 5

\n
\n

object

\n

Schema for a Change Event-based trigger.

\n
\n
\n
\n
\n
\n

changeEventTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Change Event.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 6

\n
\n

object

\n

Schema for a Database Monitoring-based trigger.

\n
\n
\n
\n
\n
\n

databaseMonitoringTrigger [required]

\n
\n

object

\n

Trigger a workflow from Database Monitoring.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 7

\n
\n

object

\n

Schema for a Datastore-based trigger.

\n
\n
\n
\n
\n
\n

datastoreTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Datastore. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 8

\n
\n

object

\n

Schema for a Dashboard-based trigger.

\n
\n
\n
\n
\n
\n

dashboardTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Dashboard.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 9

\n
\n

object

\n

Schema for a Form-based trigger.

\n
\n
\n
\n
\n
\n

formTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Form.

\n
\n
\n
\n
\n
\n

formId

\n
\n

string

\n

The form UUID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 10

\n
\n

object

\n

Schema for a GitHub webhook-based trigger.

\n
\n
\n
\n
\n
\n

githubWebhookTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 11

\n
\n

object

\n

Schema for an incident declared trigger.

\n
\n
\n
\n
\n
\n

incidentCreatedTrigger [required]

\n
\n

object

\n

Trigger a workflow when an incident is declared.

\n
\n
\n
\n
\n
\n

incidentType

\n
\n

string

\n

The type of incident that triggers the workflow.

\n
\n \n
\n
\n
\n
\n
\n

tagCondition

\n
\n

object

\n

Conditions that determine which incidents trigger the workflow.

\n
\n
\n
\n
\n
\n

tagValues

\n
\n

[object]

\n

Incident tags and values used to filter matching incidents.

\n
\n
\n
\n
\n
\n

tag [required]

\n
\n

string

\n

The incident tag to match.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The accepted values for the incident tag.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 12

\n
\n

object

\n

Schema for an incident impact created trigger.

\n
\n
\n
\n
\n
\n

incidentImpactCreatedTrigger [required]

\n
\n

object

\n

Trigger a workflow when an impact is created for an incident.

\n
\n
\n
\n
\n
\n

executionLimit

\n
\n

object

\n

The maximum number of times to execute a workflow for an incident.

\n
\n
\n
\n
\n
\n

count [required]

\n
\n

int32

\n

The maximum number of workflow executions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

incidentType

\n
\n

string

\n

The type of incident that triggers the workflow.

\n
\n \n
\n
\n
\n
\n
\n

tagCondition

\n
\n

object

\n

Conditions that determine which incidents trigger the workflow.

\n
\n
\n
\n
\n
\n

tagValues

\n
\n

[object]

\n

Incident tags and values used to filter matching incidents.

\n
\n
\n
\n
\n
\n

tag [required]

\n
\n

string

\n

The incident tag to match.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The accepted values for the incident tag.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 13

\n
\n

object

\n

Schema for an incident impact updated trigger.

\n
\n
\n
\n
\n
\n

incidentImpactUpdatedTrigger [required]

\n
\n

object

\n

Trigger a workflow when an impact is updated for an incident.

\n
\n
\n
\n
\n
\n

executionLimit

\n
\n

object

\n

The maximum number of times to execute a workflow for an incident.

\n
\n
\n
\n
\n
\n

count [required]

\n
\n

int32

\n

The maximum number of workflow executions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

incidentType

\n
\n

string

\n

The type of incident that triggers the workflow.

\n
\n \n
\n
\n
\n
\n
\n

tagCondition

\n
\n

object

\n

Conditions that determine which incidents trigger the workflow.

\n
\n
\n
\n
\n
\n

tagValues

\n
\n

[object]

\n

Incident tags and values used to filter matching incidents.

\n
\n
\n
\n
\n
\n

tag [required]

\n
\n

string

\n

The incident tag to match.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The accepted values for the incident tag.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 14

\n
\n

object

\n

Schema for an incident postmortem updated trigger.

\n
\n
\n
\n
\n
\n

incidentPostmortemUpdatedTrigger [required]

\n
\n

object

\n

Trigger a workflow when a postmortem is updated for an incident.

\n
\n
\n
\n
\n
\n

executionLimit

\n
\n

object

\n

The maximum number of times to execute a workflow for an incident.

\n
\n
\n
\n
\n
\n

count [required]

\n
\n

int32

\n

The maximum number of workflow executions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

incidentType

\n
\n

string

\n

The type of incident that triggers the workflow.

\n
\n \n
\n
\n
\n
\n
\n

tagCondition

\n
\n

object

\n

Conditions that determine which incidents trigger the workflow.

\n
\n
\n
\n
\n
\n

tagValues

\n
\n

[object]

\n

Incident tags and values used to filter matching incidents.

\n
\n
\n
\n
\n
\n

tag [required]

\n
\n

string

\n

The incident tag to match.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The accepted values for the incident tag.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 15

\n
\n

object

\n

Schema for an incident responder created trigger.

\n
\n
\n
\n
\n
\n

incidentResponderCreatedTrigger [required]

\n
\n

object

\n

Trigger a workflow when a responder is created for an incident.

\n
\n
\n
\n
\n
\n

executionLimit

\n
\n

object

\n

The maximum number of times to execute a workflow for an incident.

\n
\n
\n
\n
\n
\n

count [required]

\n
\n

int32

\n

The maximum number of workflow executions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

incidentType

\n
\n

string

\n

The type of incident that triggers the workflow.

\n
\n \n
\n
\n
\n
\n
\n

tagCondition

\n
\n

object

\n

Conditions that determine which incidents trigger the workflow.

\n
\n
\n
\n
\n
\n

tagValues

\n
\n

[object]

\n

Incident tags and values used to filter matching incidents.

\n
\n
\n
\n
\n
\n

tag [required]

\n
\n

string

\n

The incident tag to match.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The accepted values for the incident tag.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 16

\n
\n

object

\n

Schema for an incident declared or updated trigger.

\n
\n
\n
\n
\n
\n

incidentSavedTrigger [required]

\n
\n

object

\n

Trigger a workflow when an incident is declared or updated.

\n
\n
\n
\n
\n
\n

executionLimit

\n
\n

object

\n

The maximum number of times to execute a workflow for an incident.

\n
\n
\n
\n
\n
\n

count [required]

\n
\n

int32

\n

The maximum number of workflow executions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

incidentType

\n
\n

string

\n

The type of incident that triggers the workflow.

\n
\n \n
\n
\n
\n
\n
\n

serialExecution

\n
\n

object

\n

Whether to execute the workflow serially for an incident.

\n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Whether serial execution is enabled.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tagCondition

\n
\n

object

\n

Conditions that determine which incidents trigger the workflow.

\n
\n
\n
\n
\n
\n

tagValues

\n
\n

[object]

\n

Incident tags and values used to filter matching incidents.

\n
\n
\n
\n
\n
\n

tag [required]

\n
\n

string

\n

The incident tag to match.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The accepted values for the incident tag.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 17

\n
\n

object

\n

Schema for an incident schedule trigger.

\n
\n
\n
\n
\n
\n

incidentScheduleTrigger [required]

\n
\n

object

\n

Trigger a workflow on a schedule for an incident.

\n
\n
\n
\n
\n
\n

incidentType

\n
\n

string

\n

The type of incident that triggers the workflow.

\n
\n \n
\n
\n
\n
\n
\n

rrule [required]

\n
\n

string

\n

The recurrence rule for the schedule, expressed as an iCalendar RRULE string.

\n
\n \n
\n
\n
\n
\n
\n

tagCondition

\n
\n

object

\n

Conditions that determine which incidents trigger the workflow.

\n
\n
\n
\n
\n
\n

tagValues

\n
\n

[object]

\n

Incident tags and values used to filter matching incidents.

\n
\n
\n
\n
\n
\n

tag [required]

\n
\n

string

\n

The incident tag to match.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The accepted values for the incident tag.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 18

\n
\n

object

\n

Schema for an incident-based trigger.

\n
\n
\n
\n
\n
\n

incidentTrigger [required]

\n
\n

object

\n

Trigger a workflow from an incident. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

version

\n
\n

string

\n

Version of the incident manual trigger.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 19

\n
\n

object

\n

Schema for a Monitor-based trigger.

\n
\n
\n
\n
\n
\n

monitorTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Monitor. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 20

\n
\n

object

\n

Schema for a Notebook-based trigger.

\n
\n
\n
\n
\n
\n

notebookTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Notebook.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 21

\n
\n

object

\n

Schema for an On-Call-based trigger.

\n
\n
\n
\n
\n
\n

onCallTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 22

\n
\n

object

\n

Schema for a Schedule-based trigger.

\n
\n
\n
\n
\n
\n

scheduleTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Schedule. The workflow must be published.

\n
\n
\n
\n
\n
\n

overlapBehavior

\n
\n

enum

\n

Controls whether a scheduled workflow run may start while another instance is still running. \nAllowed enum values: EXCLUSIVE_RUN,OVERLAP_ALLOWED

default: EXCLUSIVE_RUN

\n
\n \n
\n
\n
\n
\n
\n

rruleExpression [required]

\n
\n

string

\n

Recurrence rule expression for scheduling.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 23

\n
\n

object

\n

Schema for a Security-based trigger.

\n
\n
\n
\n
\n
\n

securityTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Security Signal or Finding. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 24

\n
\n

object

\n

Schema for a Self Service-based trigger.

\n
\n
\n
\n
\n
\n

selfServiceTrigger [required]

\n
\n

object

\n

Trigger a workflow from Self Service.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 25

\n
\n

object

\n

Schema for a Slack-based trigger.

\n
\n
\n
\n
\n
\n

slackTrigger [required]

\n
\n

object

\n

Trigger a workflow from Slack. The workflow must be published.

\n
\n
\n
\n
\n
\n

reactionTriggers

\n
\n

[object]

\n

Slack emoji reactions that trigger the workflow.

\n
\n
\n
\n
\n
\n

reactionEmoji [required]

\n
\n

string

\n

The Slack emoji reaction name.

\n
\n \n
\n
\n
\n
\n
\n

teamId [required]

\n
\n

string

\n

The Slack workspace ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 26

\n
\n

object

\n

Schema for a Software Catalog-based trigger.

\n
\n
\n
\n
\n
\n

softwareCatalogTrigger [required]

\n
\n

object

\n

Trigger a workflow from Software Catalog.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 27

\n
\n

object

\n

Schema for a Workflow-based trigger.

\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n

workflowTrigger [required]

\n
\n

object

\n

Trigger a workflow from the Datadog UI. When present, this must be the workflow's only trigger.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

date-time

\n

When the workflow was last updated.

\n
\n \n
\n
\n
\n
\n
\n

webhookSecret

\n
\n

string

\n

If a Webhook trigger is defined on this workflow, a webhookSecret is required and should be provided here.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The workflow identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The definition of WorkflowDataRelationships object.

\n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

The definition of WorkflowUserRelationship object.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of WorkflowUserRelationshipData object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

owner

\n
\n

object

\n

The definition of WorkflowUserRelationship object.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of WorkflowUserRelationshipData object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

runAs

\n
\n

object

\n

The service account used to run the workflow. Present when runAsUserMode is service_account.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of WorkflowUserRelationshipData object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowDataType object. \nAllowed enum values: workflows

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

Data related to the workflow.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The definition of WorkflowDataAttributes object.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

When the workflow was created.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

published

\n
\n

boolean

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

runAsUserMode

\n
\n

enum

\n

The effective type of identity used to run the workflow. \nAllowed enum values: owner,service_account,initiator

\n
\n \n
\n
\n
\n
\n
\n

spec [required]

\n
\n

object

\n

A complete Workflow Automation definition, including its triggers, steps, and connections.

\n
\n
\n
\n
\n
\n

annotations

\n
\n

[object]

\n

Up to 100 text annotations displayed on the workflow canvas.

\n
\n
\n
\n
\n
\n

display [required]

\n
\n

object

\n

The annotation's position and size on the workflow canvas.

\n
\n
\n
\n
\n
\n

bounds

\n
\n

object

\n

Canvas coordinates and dimensions for an annotation on the workflow canvas.

\n
\n
\n
\n
\n
\n

height

\n
\n

double

\n

The annotation's height on the canvas.

\n
\n \n
\n
\n
\n
\n
\n

width

\n
\n

double

\n

The annotation's width on the canvas.

\n
\n \n
\n
\n
\n
\n
\n

x

\n
\n

double

\n

The annotation's horizontal canvas coordinate.

\n
\n \n
\n
\n
\n
\n
\n

y

\n
\n

double

\n

The annotation's vertical canvas coordinate.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of this annotation within the workflow.

\n
\n \n
\n
\n
\n
\n
\n

markdownTextAnnotation [required]

\n
\n

object

\n

Markdown content displayed in an annotation.

\n
\n
\n
\n
\n
\n

text

\n
\n

string

\n

The annotation's Markdown content.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

connectionEnvs

\n
\n

[object]

\n

A list of connections or connection groups used in the workflow.

\n
\n
\n
\n
\n
\n

connectionGroups

\n
\n

[object]

\n

The ConnectionEnv connectionGroups.

\n
\n
\n
\n
\n
\n

connectionGroupId [required]

\n
\n

string

\n

The ConnectionGroup connectionGroupId.

\n
\n \n
\n
\n
\n
\n
\n

label [required]

\n
\n

string

\n

The ConnectionGroup label.

\n
\n \n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

The ConnectionGroup tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

connections

\n
\n

[object]

\n

The ConnectionEnv connections.

\n
\n
\n
\n
\n
\n

connectionId [required]

\n
\n

string

\n

The Connection connectionId.

\n
\n \n
\n
\n
\n
\n
\n

label [required]

\n
\n

string

\n

The Connection label.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

env [required]

\n
\n

enum

\n

The definition of ConnectionEnvEnv object. \nAllowed enum values: default

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Unique identifier used to trigger workflows automatically in Datadog.

\n
\n \n
\n
\n
\n
\n
\n

inputSchema

\n
\n

object

\n

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

\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

The InputSchema parameters.

\n
\n
\n
\n
\n
\n

allowExtraValues

\n
\n

boolean

\n

The InputSchemaParameters allowExtraValues.

\n
\n \n
\n
\n
\n
\n
\n

allowedValues

\n
\n

\n

The InputSchemaParameters allowedValues.

\n
\n \n
\n
\n
\n
\n
\n

defaultValue

\n
\n

\n

The InputSchemaParameters defaultValue.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The InputSchemaParameters description.

\n
\n \n
\n
\n
\n
\n
\n

label

\n
\n

string

\n

The InputSchemaParameters label.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The InputSchemaParameters name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of InputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

outputSchema

\n
\n

object

\n

A list of output parameters for the workflow.

\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

The OutputSchema parameters.

\n
\n
\n
\n
\n
\n

defaultValue

\n
\n

\n

The OutputSchemaParameters defaultValue.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The OutputSchemaParameters description.

\n
\n \n
\n
\n
\n
\n
\n

label

\n
\n

string

\n

The OutputSchemaParameters label.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The OutputSchemaParameters name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of OutputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

\n

The OutputSchemaParameters value.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

A Step is a sub-component of a workflow. Each Step performs an action.

\n
\n
\n
\n
\n
\n

actionId [required]

\n
\n

string

\n

The unique identifier of an action.

\n
\n \n
\n
\n
\n
\n
\n

completionGate

\n
\n

object

\n

Used to create conditions before running subsequent actions.

\n
\n
\n
\n
\n
\n

completionCondition [required]

\n
\n

object

\n

The definition of CompletionCondition object.

\n
\n
\n
\n
\n
\n

operand1 [required]

\n
\n

\n

The CompletionCondition operand1.

\n
\n \n
\n
\n
\n
\n
\n

operand2

\n
\n

\n

The CompletionCondition operand2.

\n
\n \n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

The definition of CompletionConditionOperator object. \nAllowed 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

Show 2 more,OPERATOR_IS_EMPTY,OPERATOR_IS_NOT_EMPTY

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

retryStrategy [required]

\n
\n

object

\n

The definition of RetryStrategy object.

\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR

\n
\n \n
\n
\n
\n
\n
\n

linear [required]

\n
\n

object

\n

The definition of RetryStrategyLinear object.

\n
\n
\n
\n
\n
\n

interval [required]

\n
\n

string

\n

The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n

maxRetries [required]

\n
\n

int32

\n

The RetryStrategyLinear maxRetries.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

connectionLabel

\n
\n

string

\n

The unique identifier of a connection defined in the spec.

\n
\n \n
\n
\n
\n
\n
\n

display

\n
\n

object

\n

The position of a step on the workflow canvas. Omit display from every step to use\nautomatic layout, or provide it for every step to preserve a manual layout.

\n
\n
\n
\n
\n
\n

bounds

\n
\n

object

\n

The definition of StepDisplayBounds object.

\n
\n
\n
\n
\n
\n

x

\n
\n

double

\n

The bounds x.

\n
\n \n
\n
\n
\n
\n
\n

y

\n
\n

double

\n

The bounds y.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

errorHandlers

\n
\n

[object]

\n

The Step errorHandlers.

\n
\n
\n
\n
\n
\n

fallbackStepName [required]

\n
\n

string

\n

The ErrorHandler fallbackStepName.

\n
\n \n
\n
\n
\n
\n
\n

retryStrategy [required]

\n
\n

object

\n

The definition of RetryStrategy object.

\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR

\n
\n \n
\n
\n
\n
\n
\n

linear [required]

\n
\n

object

\n

The definition of RetryStrategyLinear object.

\n
\n
\n
\n
\n
\n

interval [required]

\n
\n

string

\n

The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n

maxRetries [required]

\n
\n

int32

\n

The RetryStrategyLinear maxRetries.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the step.

\n
\n \n
\n
\n
\n
\n
\n

outboundEdges

\n
\n

[object]

\n

A list of subsequent actions to run. This list is empty for a terminal step.

\n
\n
\n
\n
\n
\n

branchName [required]

\n
\n

string

\n

The OutboundEdge branchName.

\n
\n \n
\n
\n
\n
\n
\n

nextStepName [required]

\n
\n

string

\n

The OutboundEdge nextStepName.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

A list of inputs for an action.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The Parameter name.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

\n

The Parameter value.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

readinessGate

\n
\n

object

\n

Used to merge multiple branches into a single branch.

\n
\n
\n
\n
\n
\n

thresholdType [required]

\n
\n

enum

\n

The definition of ReadinessGateThresholdType object. \nAllowed enum values: ANY,ALL

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

triggers

\n
\n

[ <oneOf>]

\n

The list of triggers that activate this workflow. At least one trigger is required, and each trigger type may appear at most once.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

Schema for an agent-based trigger.

\n
\n
\n
\n
\n
\n

agentTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Schema for an API-based trigger.

\n
\n
\n
\n
\n
\n

apiTrigger [required]

\n
\n

object

\n

Trigger a workflow from an API request. The workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 3

\n
\n

object

\n

Schema for an App-based trigger.

\n
\n
\n
\n
\n
\n

appTrigger [required]

\n
\n

object

\n

Trigger a workflow from an App.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 4

\n
\n

object

\n

Schema for a Case-based trigger.

\n
\n
\n
\n
\n
\n

caseTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Case. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 5

\n
\n

object

\n

Schema for a Change Event-based trigger.

\n
\n
\n
\n
\n
\n

changeEventTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Change Event.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 6

\n
\n

object

\n

Schema for a Database Monitoring-based trigger.

\n
\n
\n
\n
\n
\n

databaseMonitoringTrigger [required]

\n
\n

object

\n

Trigger a workflow from Database Monitoring.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 7

\n
\n

object

\n

Schema for a Datastore-based trigger.

\n
\n
\n
\n
\n
\n

datastoreTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Datastore. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 8

\n
\n

object

\n

Schema for a Dashboard-based trigger.

\n
\n
\n
\n
\n
\n

dashboardTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Dashboard.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 9

\n
\n

object

\n

Schema for a Form-based trigger.

\n
\n
\n
\n
\n
\n

formTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Form.

\n
\n
\n
\n
\n
\n

formId

\n
\n

string

\n

The form UUID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 10

\n
\n

object

\n

Schema for a GitHub webhook-based trigger.

\n
\n
\n
\n
\n
\n

githubWebhookTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 11

\n
\n

object

\n

Schema for an incident declared trigger.

\n
\n
\n
\n
\n
\n

incidentCreatedTrigger [required]

\n
\n

object

\n

Trigger a workflow when an incident is declared.

\n
\n
\n
\n
\n
\n

incidentType

\n
\n

string

\n

The type of incident that triggers the workflow.

\n
\n \n
\n
\n
\n
\n
\n

tagCondition

\n
\n

object

\n

Conditions that determine which incidents trigger the workflow.

\n
\n
\n
\n
\n
\n

tagValues

\n
\n

[object]

\n

Incident tags and values used to filter matching incidents.

\n
\n
\n
\n
\n
\n

tag [required]

\n
\n

string

\n

The incident tag to match.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The accepted values for the incident tag.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 12

\n
\n

object

\n

Schema for an incident impact created trigger.

\n
\n
\n
\n
\n
\n

incidentImpactCreatedTrigger [required]

\n
\n

object

\n

Trigger a workflow when an impact is created for an incident.

\n
\n
\n
\n
\n
\n

executionLimit

\n
\n

object

\n

The maximum number of times to execute a workflow for an incident.

\n
\n
\n
\n
\n
\n

count [required]

\n
\n

int32

\n

The maximum number of workflow executions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

incidentType

\n
\n

string

\n

The type of incident that triggers the workflow.

\n
\n \n
\n
\n
\n
\n
\n

tagCondition

\n
\n

object

\n

Conditions that determine which incidents trigger the workflow.

\n
\n
\n
\n
\n
\n

tagValues

\n
\n

[object]

\n

Incident tags and values used to filter matching incidents.

\n
\n
\n
\n
\n
\n

tag [required]

\n
\n

string

\n

The incident tag to match.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The accepted values for the incident tag.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 13

\n
\n

object

\n

Schema for an incident impact updated trigger.

\n
\n
\n
\n
\n
\n

incidentImpactUpdatedTrigger [required]

\n
\n

object

\n

Trigger a workflow when an impact is updated for an incident.

\n
\n
\n
\n
\n
\n

executionLimit

\n
\n

object

\n

The maximum number of times to execute a workflow for an incident.

\n
\n
\n
\n
\n
\n

count [required]

\n
\n

int32

\n

The maximum number of workflow executions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

incidentType

\n
\n

string

\n

The type of incident that triggers the workflow.

\n
\n \n
\n
\n
\n
\n
\n

tagCondition

\n
\n

object

\n

Conditions that determine which incidents trigger the workflow.

\n
\n
\n
\n
\n
\n

tagValues

\n
\n

[object]

\n

Incident tags and values used to filter matching incidents.

\n
\n
\n
\n
\n
\n

tag [required]

\n
\n

string

\n

The incident tag to match.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The accepted values for the incident tag.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 14

\n
\n

object

\n

Schema for an incident postmortem updated trigger.

\n
\n
\n
\n
\n
\n

incidentPostmortemUpdatedTrigger [required]

\n
\n

object

\n

Trigger a workflow when a postmortem is updated for an incident.

\n
\n
\n
\n
\n
\n

executionLimit

\n
\n

object

\n

The maximum number of times to execute a workflow for an incident.

\n
\n
\n
\n
\n
\n

count [required]

\n
\n

int32

\n

The maximum number of workflow executions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

incidentType

\n
\n

string

\n

The type of incident that triggers the workflow.

\n
\n \n
\n
\n
\n
\n
\n

tagCondition

\n
\n

object

\n

Conditions that determine which incidents trigger the workflow.

\n
\n
\n
\n
\n
\n

tagValues

\n
\n

[object]

\n

Incident tags and values used to filter matching incidents.

\n
\n
\n
\n
\n
\n

tag [required]

\n
\n

string

\n

The incident tag to match.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The accepted values for the incident tag.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 15

\n
\n

object

\n

Schema for an incident responder created trigger.

\n
\n
\n
\n
\n
\n

incidentResponderCreatedTrigger [required]

\n
\n

object

\n

Trigger a workflow when a responder is created for an incident.

\n
\n
\n
\n
\n
\n

executionLimit

\n
\n

object

\n

The maximum number of times to execute a workflow for an incident.

\n
\n
\n
\n
\n
\n

count [required]

\n
\n

int32

\n

The maximum number of workflow executions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

incidentType

\n
\n

string

\n

The type of incident that triggers the workflow.

\n
\n \n
\n
\n
\n
\n
\n

tagCondition

\n
\n

object

\n

Conditions that determine which incidents trigger the workflow.

\n
\n
\n
\n
\n
\n

tagValues

\n
\n

[object]

\n

Incident tags and values used to filter matching incidents.

\n
\n
\n
\n
\n
\n

tag [required]

\n
\n

string

\n

The incident tag to match.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The accepted values for the incident tag.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 16

\n
\n

object

\n

Schema for an incident declared or updated trigger.

\n
\n
\n
\n
\n
\n

incidentSavedTrigger [required]

\n
\n

object

\n

Trigger a workflow when an incident is declared or updated.

\n
\n
\n
\n
\n
\n

executionLimit

\n
\n

object

\n

The maximum number of times to execute a workflow for an incident.

\n
\n
\n
\n
\n
\n

count [required]

\n
\n

int32

\n

The maximum number of workflow executions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

incidentType

\n
\n

string

\n

The type of incident that triggers the workflow.

\n
\n \n
\n
\n
\n
\n
\n

serialExecution

\n
\n

object

\n

Whether to execute the workflow serially for an incident.

\n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Whether serial execution is enabled.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tagCondition

\n
\n

object

\n

Conditions that determine which incidents trigger the workflow.

\n
\n
\n
\n
\n
\n

tagValues

\n
\n

[object]

\n

Incident tags and values used to filter matching incidents.

\n
\n
\n
\n
\n
\n

tag [required]

\n
\n

string

\n

The incident tag to match.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The accepted values for the incident tag.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 17

\n
\n

object

\n

Schema for an incident schedule trigger.

\n
\n
\n
\n
\n
\n

incidentScheduleTrigger [required]

\n
\n

object

\n

Trigger a workflow on a schedule for an incident.

\n
\n
\n
\n
\n
\n

incidentType

\n
\n

string

\n

The type of incident that triggers the workflow.

\n
\n \n
\n
\n
\n
\n
\n

rrule [required]

\n
\n

string

\n

The recurrence rule for the schedule, expressed as an iCalendar RRULE string.

\n
\n \n
\n
\n
\n
\n
\n

tagCondition

\n
\n

object

\n

Conditions that determine which incidents trigger the workflow.

\n
\n
\n
\n
\n
\n

tagValues

\n
\n

[object]

\n

Incident tags and values used to filter matching incidents.

\n
\n
\n
\n
\n
\n

tag [required]

\n
\n

string

\n

The incident tag to match.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The accepted values for the incident tag.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 18

\n
\n

object

\n

Schema for an incident-based trigger.

\n
\n
\n
\n
\n
\n

incidentTrigger [required]

\n
\n

object

\n

Trigger a workflow from an incident. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

version

\n
\n

string

\n

Version of the incident manual trigger.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 19

\n
\n

object

\n

Schema for a Monitor-based trigger.

\n
\n
\n
\n
\n
\n

monitorTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Monitor. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 20

\n
\n

object

\n

Schema for a Notebook-based trigger.

\n
\n
\n
\n
\n
\n

notebookTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Notebook.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 21

\n
\n

object

\n

Schema for an On-Call-based trigger.

\n
\n
\n
\n
\n
\n

onCallTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 22

\n
\n

object

\n

Schema for a Schedule-based trigger.

\n
\n
\n
\n
\n
\n

scheduleTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Schedule. The workflow must be published.

\n
\n
\n
\n
\n
\n

overlapBehavior

\n
\n

enum

\n

Controls whether a scheduled workflow run may start while another instance is still running. \nAllowed enum values: EXCLUSIVE_RUN,OVERLAP_ALLOWED

default: EXCLUSIVE_RUN

\n
\n \n
\n
\n
\n
\n
\n

rruleExpression [required]

\n
\n

string

\n

Recurrence rule expression for scheduling.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 23

\n
\n

object

\n

Schema for a Security-based trigger.

\n
\n
\n
\n
\n
\n

securityTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Security Signal or Finding. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 24

\n
\n

object

\n

Schema for a Self Service-based trigger.

\n
\n
\n
\n
\n
\n

selfServiceTrigger [required]

\n
\n

object

\n

Trigger a workflow from Self Service.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 25

\n
\n

object

\n

Schema for a Slack-based trigger.

\n
\n
\n
\n
\n
\n

slackTrigger [required]

\n
\n

object

\n

Trigger a workflow from Slack. The workflow must be published.

\n
\n
\n
\n
\n
\n

reactionTriggers

\n
\n

[object]

\n

Slack emoji reactions that trigger the workflow.

\n
\n
\n
\n
\n
\n

reactionEmoji [required]

\n
\n

string

\n

The Slack emoji reaction name.

\n
\n \n
\n
\n
\n
\n
\n

teamId [required]

\n
\n

string

\n

The Slack workspace ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 26

\n
\n

object

\n

Schema for a Software Catalog-based trigger.

\n
\n
\n
\n
\n
\n

softwareCatalogTrigger [required]

\n
\n

object

\n

Trigger a workflow from Software Catalog.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 27

\n
\n

object

\n

Schema for a Workflow-based trigger.

\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n

workflowTrigger [required]

\n
\n

object

\n

Trigger a workflow from the Datadog UI. When present, this must be the workflow's only trigger.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

date-time

\n

When the workflow was last updated.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The workflow identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The definition of WorkflowDataRelationships object.

\n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

The definition of WorkflowUserRelationship object.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of WorkflowUserRelationshipData object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

owner

\n
\n

object

\n

The definition of WorkflowUserRelationship object.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of WorkflowUserRelationshipData object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

runAs

\n
\n

object

\n

The service account used to run the workflow. Present when runAsUserMode is service_account.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of WorkflowUserRelationshipData object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowDataType object. \nAllowed enum values: workflows

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -761,9 +757,6 @@ "description": "string", "name": "", "published": false, - "runAs": { - "type": "owner" - }, "runAsUserMode": "owner", "spec": { "annotations": [ @@ -897,8 +890,7 @@ ] }, "tags": [], - "updatedAt": "2019-09-19T10:00:00.000Z", - "webhookSecret": "string" + "updatedAt": "2019-09-19T10:00:00.000Z" }, "id": "string", "relationships": { @@ -924,7 +916,7 @@ "type": "workflows" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Data related to the workflow.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The definition of WorkflowDataAttributes object.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

When the workflow was created.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

published

\n
\n

boolean

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

runAs

\n
\n

 <oneOf>

\n

Identity used to run the workflow.

\n
\n
\n
\n
\n
\n

<type=owner>

\n
\n

object

\n

Run the workflow as its owner.

\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The owner run-as type. \nAllowed enum values: owner

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=service_account>

\n
\n

object

\n

Run the workflow as a service account.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The service account identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The service account run-as type. \nAllowed enum values: service_account

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=initiator>

\n
\n

object

\n

Run the workflow as the user who initiates the execution.

\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The initiator run-as type. \nAllowed enum values: initiator

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

runAsUserMode

\n
\n

enum

\n

The effective type of identity used to run the workflow. \nAllowed enum values: owner,service_account,initiator

\n
\n \n
\n
\n
\n
\n
\n

spec [required]

\n
\n

object

\n

A complete Workflow Automation definition, including its triggers, steps, and connections.

\n
\n
\n
\n
\n
\n

annotations

\n
\n

[object]

\n

Up to 100 text annotations displayed on the workflow canvas.

\n
\n
\n
\n
\n
\n

display [required]

\n
\n

object

\n

The annotation's position and size on the workflow canvas.

\n
\n
\n
\n
\n
\n

bounds

\n
\n

object

\n

Canvas coordinates and dimensions for an annotation on the workflow canvas.

\n
\n
\n
\n
\n
\n

height

\n
\n

double

\n

The annotation's height on the canvas.

\n
\n \n
\n
\n
\n
\n
\n

width

\n
\n

double

\n

The annotation's width on the canvas.

\n
\n \n
\n
\n
\n
\n
\n

x

\n
\n

double

\n

The annotation's horizontal canvas coordinate.

\n
\n \n
\n
\n
\n
\n
\n

y

\n
\n

double

\n

The annotation's vertical canvas coordinate.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of this annotation within the workflow.

\n
\n \n
\n
\n
\n
\n
\n

markdownTextAnnotation [required]

\n
\n

object

\n

Markdown content displayed in an annotation.

\n
\n
\n
\n
\n
\n

text

\n
\n

string

\n

The annotation's Markdown content.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

connectionEnvs

\n
\n

[object]

\n

A list of connections or connection groups used in the workflow.

\n
\n
\n
\n
\n
\n

connectionGroups

\n
\n

[object]

\n

The ConnectionEnv connectionGroups.

\n
\n
\n
\n
\n
\n

connectionGroupId [required]

\n
\n

string

\n

The ConnectionGroup connectionGroupId.

\n
\n \n
\n
\n
\n
\n
\n

label [required]

\n
\n

string

\n

The ConnectionGroup label.

\n
\n \n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

The ConnectionGroup tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

connections

\n
\n

[object]

\n

The ConnectionEnv connections.

\n
\n
\n
\n
\n
\n

connectionId [required]

\n
\n

string

\n

The Connection connectionId.

\n
\n \n
\n
\n
\n
\n
\n

label [required]

\n
\n

string

\n

The Connection label.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

env [required]

\n
\n

enum

\n

The definition of ConnectionEnvEnv object. \nAllowed enum values: default

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Unique identifier used to trigger workflows automatically in Datadog.

\n
\n \n
\n
\n
\n
\n
\n

inputSchema

\n
\n

object

\n

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

\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

The InputSchema parameters.

\n
\n
\n
\n
\n
\n

allowExtraValues

\n
\n

boolean

\n

The InputSchemaParameters allowExtraValues.

\n
\n \n
\n
\n
\n
\n
\n

allowedValues

\n
\n

\n

The InputSchemaParameters allowedValues.

\n
\n \n
\n
\n
\n
\n
\n

defaultValue

\n
\n

\n

The InputSchemaParameters defaultValue.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The InputSchemaParameters description.

\n
\n \n
\n
\n
\n
\n
\n

label

\n
\n

string

\n

The InputSchemaParameters label.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The InputSchemaParameters name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of InputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

outputSchema

\n
\n

object

\n

A list of output parameters for the workflow.

\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

The OutputSchema parameters.

\n
\n
\n
\n
\n
\n

defaultValue

\n
\n

\n

The OutputSchemaParameters defaultValue.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The OutputSchemaParameters description.

\n
\n \n
\n
\n
\n
\n
\n

label

\n
\n

string

\n

The OutputSchemaParameters label.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The OutputSchemaParameters name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of OutputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

\n

The OutputSchemaParameters value.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

A Step is a sub-component of a workflow. Each Step performs an action.

\n
\n
\n
\n
\n
\n

actionId [required]

\n
\n

string

\n

The unique identifier of an action.

\n
\n \n
\n
\n
\n
\n
\n

completionGate

\n
\n

object

\n

Used to create conditions before running subsequent actions.

\n
\n
\n
\n
\n
\n

completionCondition [required]

\n
\n

object

\n

The definition of CompletionCondition object.

\n
\n
\n
\n
\n
\n

operand1 [required]

\n
\n

\n

The CompletionCondition operand1.

\n
\n \n
\n
\n
\n
\n
\n

operand2

\n
\n

\n

The CompletionCondition operand2.

\n
\n \n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

The definition of CompletionConditionOperator object. \nAllowed 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

Show 2 more,OPERATOR_IS_EMPTY,OPERATOR_IS_NOT_EMPTY

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

retryStrategy [required]

\n
\n

object

\n

The definition of RetryStrategy object.

\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR

\n
\n \n
\n
\n
\n
\n
\n

linear [required]

\n
\n

object

\n

The definition of RetryStrategyLinear object.

\n
\n
\n
\n
\n
\n

interval [required]

\n
\n

string

\n

The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n

maxRetries [required]

\n
\n

int32

\n

The RetryStrategyLinear maxRetries.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

connectionLabel

\n
\n

string

\n

The unique identifier of a connection defined in the spec.

\n
\n \n
\n
\n
\n
\n
\n

display

\n
\n

object

\n

The position of a step on the workflow canvas. Omit display from every step to use\nautomatic layout, or provide it for every step to preserve a manual layout.

\n
\n
\n
\n
\n
\n

bounds

\n
\n

object

\n

The definition of StepDisplayBounds object.

\n
\n
\n
\n
\n
\n

x

\n
\n

double

\n

The bounds x.

\n
\n \n
\n
\n
\n
\n
\n

y

\n
\n

double

\n

The bounds y.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

errorHandlers

\n
\n

[object]

\n

The Step errorHandlers.

\n
\n
\n
\n
\n
\n

fallbackStepName [required]

\n
\n

string

\n

The ErrorHandler fallbackStepName.

\n
\n \n
\n
\n
\n
\n
\n

retryStrategy [required]

\n
\n

object

\n

The definition of RetryStrategy object.

\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR

\n
\n \n
\n
\n
\n
\n
\n

linear [required]

\n
\n

object

\n

The definition of RetryStrategyLinear object.

\n
\n
\n
\n
\n
\n

interval [required]

\n
\n

string

\n

The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n

maxRetries [required]

\n
\n

int32

\n

The RetryStrategyLinear maxRetries.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the step.

\n
\n \n
\n
\n
\n
\n
\n

outboundEdges

\n
\n

[object]

\n

A list of subsequent actions to run. This list is empty for a terminal step.

\n
\n
\n
\n
\n
\n

branchName [required]

\n
\n

string

\n

The OutboundEdge branchName.

\n
\n \n
\n
\n
\n
\n
\n

nextStepName [required]

\n
\n

string

\n

The OutboundEdge nextStepName.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

A list of inputs for an action.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The Parameter name.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

\n

The Parameter value.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

readinessGate

\n
\n

object

\n

Used to merge multiple branches into a single branch.

\n
\n
\n
\n
\n
\n

thresholdType [required]

\n
\n

enum

\n

The definition of ReadinessGateThresholdType object. \nAllowed enum values: ANY,ALL

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

triggers

\n
\n

[ <oneOf>]

\n

The list of triggers that activate this workflow. At least one trigger is required, and each trigger type may appear at most once.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

Schema for an agent-based trigger.

\n
\n
\n
\n
\n
\n

agentTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Schema for an API-based trigger.

\n
\n
\n
\n
\n
\n

apiTrigger [required]

\n
\n

object

\n

Trigger a workflow from an API request. The workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 3

\n
\n

object

\n

Schema for an App-based trigger.

\n
\n
\n
\n
\n
\n

appTrigger [required]

\n
\n

object

\n

Trigger a workflow from an App.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 4

\n
\n

object

\n

Schema for a Case-based trigger.

\n
\n
\n
\n
\n
\n

caseTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Case. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 5

\n
\n

object

\n

Schema for a Change Event-based trigger.

\n
\n
\n
\n
\n
\n

changeEventTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Change Event.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 6

\n
\n

object

\n

Schema for a Database Monitoring-based trigger.

\n
\n
\n
\n
\n
\n

databaseMonitoringTrigger [required]

\n
\n

object

\n

Trigger a workflow from Database Monitoring.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 7

\n
\n

object

\n

Schema for a Datastore-based trigger.

\n
\n
\n
\n
\n
\n

datastoreTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Datastore. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 8

\n
\n

object

\n

Schema for a Dashboard-based trigger.

\n
\n
\n
\n
\n
\n

dashboardTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Dashboard.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 9

\n
\n

object

\n

Schema for a Form-based trigger.

\n
\n
\n
\n
\n
\n

formTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Form.

\n
\n
\n
\n
\n
\n

formId

\n
\n

string

\n

The form UUID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 10

\n
\n

object

\n

Schema for a GitHub webhook-based trigger.

\n
\n
\n
\n
\n
\n

githubWebhookTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 11

\n
\n

object

\n

Schema for an incident declared trigger.

\n
\n
\n
\n
\n
\n

incidentCreatedTrigger [required]

\n
\n

object

\n

Trigger a workflow when an incident is declared.

\n
\n
\n
\n
\n
\n

incidentType

\n
\n

string

\n

The type of incident that triggers the workflow.

\n
\n \n
\n
\n
\n
\n
\n

tagCondition

\n
\n

object

\n

Conditions that determine which incidents trigger the workflow.

\n
\n
\n
\n
\n
\n

tagValues

\n
\n

[object]

\n

Incident tags and values used to filter matching incidents.

\n
\n
\n
\n
\n
\n

tag [required]

\n
\n

string

\n

The incident tag to match.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The accepted values for the incident tag.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 12

\n
\n

object

\n

Schema for an incident impact created trigger.

\n
\n
\n
\n
\n
\n

incidentImpactCreatedTrigger [required]

\n
\n

object

\n

Trigger a workflow when an impact is created for an incident.

\n
\n
\n
\n
\n
\n

executionLimit

\n
\n

object

\n

The maximum number of times to execute a workflow for an incident.

\n
\n
\n
\n
\n
\n

count [required]

\n
\n

int32

\n

The maximum number of workflow executions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

incidentType

\n
\n

string

\n

The type of incident that triggers the workflow.

\n
\n \n
\n
\n
\n
\n
\n

tagCondition

\n
\n

object

\n

Conditions that determine which incidents trigger the workflow.

\n
\n
\n
\n
\n
\n

tagValues

\n
\n

[object]

\n

Incident tags and values used to filter matching incidents.

\n
\n
\n
\n
\n
\n

tag [required]

\n
\n

string

\n

The incident tag to match.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The accepted values for the incident tag.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 13

\n
\n

object

\n

Schema for an incident impact updated trigger.

\n
\n
\n
\n
\n
\n

incidentImpactUpdatedTrigger [required]

\n
\n

object

\n

Trigger a workflow when an impact is updated for an incident.

\n
\n
\n
\n
\n
\n

executionLimit

\n
\n

object

\n

The maximum number of times to execute a workflow for an incident.

\n
\n
\n
\n
\n
\n

count [required]

\n
\n

int32

\n

The maximum number of workflow executions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

incidentType

\n
\n

string

\n

The type of incident that triggers the workflow.

\n
\n \n
\n
\n
\n
\n
\n

tagCondition

\n
\n

object

\n

Conditions that determine which incidents trigger the workflow.

\n
\n
\n
\n
\n
\n

tagValues

\n
\n

[object]

\n

Incident tags and values used to filter matching incidents.

\n
\n
\n
\n
\n
\n

tag [required]

\n
\n

string

\n

The incident tag to match.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The accepted values for the incident tag.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 14

\n
\n

object

\n

Schema for an incident postmortem updated trigger.

\n
\n
\n
\n
\n
\n

incidentPostmortemUpdatedTrigger [required]

\n
\n

object

\n

Trigger a workflow when a postmortem is updated for an incident.

\n
\n
\n
\n
\n
\n

executionLimit

\n
\n

object

\n

The maximum number of times to execute a workflow for an incident.

\n
\n
\n
\n
\n
\n

count [required]

\n
\n

int32

\n

The maximum number of workflow executions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

incidentType

\n
\n

string

\n

The type of incident that triggers the workflow.

\n
\n \n
\n
\n
\n
\n
\n

tagCondition

\n
\n

object

\n

Conditions that determine which incidents trigger the workflow.

\n
\n
\n
\n
\n
\n

tagValues

\n
\n

[object]

\n

Incident tags and values used to filter matching incidents.

\n
\n
\n
\n
\n
\n

tag [required]

\n
\n

string

\n

The incident tag to match.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The accepted values for the incident tag.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 15

\n
\n

object

\n

Schema for an incident responder created trigger.

\n
\n
\n
\n
\n
\n

incidentResponderCreatedTrigger [required]

\n
\n

object

\n

Trigger a workflow when a responder is created for an incident.

\n
\n
\n
\n
\n
\n

executionLimit

\n
\n

object

\n

The maximum number of times to execute a workflow for an incident.

\n
\n
\n
\n
\n
\n

count [required]

\n
\n

int32

\n

The maximum number of workflow executions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

incidentType

\n
\n

string

\n

The type of incident that triggers the workflow.

\n
\n \n
\n
\n
\n
\n
\n

tagCondition

\n
\n

object

\n

Conditions that determine which incidents trigger the workflow.

\n
\n
\n
\n
\n
\n

tagValues

\n
\n

[object]

\n

Incident tags and values used to filter matching incidents.

\n
\n
\n
\n
\n
\n

tag [required]

\n
\n

string

\n

The incident tag to match.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The accepted values for the incident tag.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 16

\n
\n

object

\n

Schema for an incident declared or updated trigger.

\n
\n
\n
\n
\n
\n

incidentSavedTrigger [required]

\n
\n

object

\n

Trigger a workflow when an incident is declared or updated.

\n
\n
\n
\n
\n
\n

executionLimit

\n
\n

object

\n

The maximum number of times to execute a workflow for an incident.

\n
\n
\n
\n
\n
\n

count [required]

\n
\n

int32

\n

The maximum number of workflow executions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

incidentType

\n
\n

string

\n

The type of incident that triggers the workflow.

\n
\n \n
\n
\n
\n
\n
\n

serialExecution

\n
\n

object

\n

Whether to execute the workflow serially for an incident.

\n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Whether serial execution is enabled.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tagCondition

\n
\n

object

\n

Conditions that determine which incidents trigger the workflow.

\n
\n
\n
\n
\n
\n

tagValues

\n
\n

[object]

\n

Incident tags and values used to filter matching incidents.

\n
\n
\n
\n
\n
\n

tag [required]

\n
\n

string

\n

The incident tag to match.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The accepted values for the incident tag.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 17

\n
\n

object

\n

Schema for an incident schedule trigger.

\n
\n
\n
\n
\n
\n

incidentScheduleTrigger [required]

\n
\n

object

\n

Trigger a workflow on a schedule for an incident.

\n
\n
\n
\n
\n
\n

incidentType

\n
\n

string

\n

The type of incident that triggers the workflow.

\n
\n \n
\n
\n
\n
\n
\n

rrule [required]

\n
\n

string

\n

The recurrence rule for the schedule, expressed as an iCalendar RRULE string.

\n
\n \n
\n
\n
\n
\n
\n

tagCondition

\n
\n

object

\n

Conditions that determine which incidents trigger the workflow.

\n
\n
\n
\n
\n
\n

tagValues

\n
\n

[object]

\n

Incident tags and values used to filter matching incidents.

\n
\n
\n
\n
\n
\n

tag [required]

\n
\n

string

\n

The incident tag to match.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The accepted values for the incident tag.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 18

\n
\n

object

\n

Schema for an incident-based trigger.

\n
\n
\n
\n
\n
\n

incidentTrigger [required]

\n
\n

object

\n

Trigger a workflow from an incident. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

version

\n
\n

string

\n

Version of the incident manual trigger.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 19

\n
\n

object

\n

Schema for a Monitor-based trigger.

\n
\n
\n
\n
\n
\n

monitorTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Monitor. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 20

\n
\n

object

\n

Schema for a Notebook-based trigger.

\n
\n
\n
\n
\n
\n

notebookTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Notebook.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 21

\n
\n

object

\n

Schema for an On-Call-based trigger.

\n
\n
\n
\n
\n
\n

onCallTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 22

\n
\n

object

\n

Schema for a Schedule-based trigger.

\n
\n
\n
\n
\n
\n

scheduleTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Schedule. The workflow must be published.

\n
\n
\n
\n
\n
\n

overlapBehavior

\n
\n

enum

\n

Controls whether a scheduled workflow run may start while another instance is still running. \nAllowed enum values: EXCLUSIVE_RUN,OVERLAP_ALLOWED

default: EXCLUSIVE_RUN

\n
\n \n
\n
\n
\n
\n
\n

rruleExpression [required]

\n
\n

string

\n

Recurrence rule expression for scheduling.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 23

\n
\n

object

\n

Schema for a Security-based trigger.

\n
\n
\n
\n
\n
\n

securityTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Security Signal or Finding. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 24

\n
\n

object

\n

Schema for a Self Service-based trigger.

\n
\n
\n
\n
\n
\n

selfServiceTrigger [required]

\n
\n

object

\n

Trigger a workflow from Self Service.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 25

\n
\n

object

\n

Schema for a Slack-based trigger.

\n
\n
\n
\n
\n
\n

slackTrigger [required]

\n
\n

object

\n

Trigger a workflow from Slack. The workflow must be published.

\n
\n
\n
\n
\n
\n

reactionTriggers

\n
\n

[object]

\n

Slack emoji reactions that trigger the workflow.

\n
\n
\n
\n
\n
\n

reactionEmoji [required]

\n
\n

string

\n

The Slack emoji reaction name.

\n
\n \n
\n
\n
\n
\n
\n

teamId [required]

\n
\n

string

\n

The Slack workspace ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 26

\n
\n

object

\n

Schema for a Software Catalog-based trigger.

\n
\n
\n
\n
\n
\n

softwareCatalogTrigger [required]

\n
\n

object

\n

Trigger a workflow from Software Catalog.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 27

\n
\n

object

\n

Schema for a Workflow-based trigger.

\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n

workflowTrigger [required]

\n
\n

object

\n

Trigger a workflow from the Datadog UI. When present, this must be the workflow's only trigger.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

date-time

\n

When the workflow was last updated.

\n
\n \n
\n
\n
\n
\n
\n

webhookSecret

\n
\n

string

\n

If a Webhook trigger is defined on this workflow, a webhookSecret is required and should be provided here.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The workflow identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The definition of WorkflowDataRelationships object.

\n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

The definition of WorkflowUserRelationship object.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of WorkflowUserRelationshipData object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

owner

\n
\n

object

\n

The definition of WorkflowUserRelationship object.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of WorkflowUserRelationshipData object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

runAs

\n
\n

object

\n

The service account used to run the workflow. Present when runAsUserMode is service_account.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of WorkflowUserRelationshipData object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowDataType object. \nAllowed enum values: workflows

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Data related to the workflow.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The definition of WorkflowDataAttributes object.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

When the workflow was created.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

published

\n
\n

boolean

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

runAsUserMode

\n
\n

enum

\n

The effective type of identity used to run the workflow. \nAllowed enum values: owner,service_account,initiator

\n
\n \n
\n
\n
\n
\n
\n

spec [required]

\n
\n

object

\n

A complete Workflow Automation definition, including its triggers, steps, and connections.

\n
\n
\n
\n
\n
\n

annotations

\n
\n

[object]

\n

Up to 100 text annotations displayed on the workflow canvas.

\n
\n
\n
\n
\n
\n

display [required]

\n
\n

object

\n

The annotation's position and size on the workflow canvas.

\n
\n
\n
\n
\n
\n

bounds

\n
\n

object

\n

Canvas coordinates and dimensions for an annotation on the workflow canvas.

\n
\n
\n
\n
\n
\n

height

\n
\n

double

\n

The annotation's height on the canvas.

\n
\n \n
\n
\n
\n
\n
\n

width

\n
\n

double

\n

The annotation's width on the canvas.

\n
\n \n
\n
\n
\n
\n
\n

x

\n
\n

double

\n

The annotation's horizontal canvas coordinate.

\n
\n \n
\n
\n
\n
\n
\n

y

\n
\n

double

\n

The annotation's vertical canvas coordinate.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of this annotation within the workflow.

\n
\n \n
\n
\n
\n
\n
\n

markdownTextAnnotation [required]

\n
\n

object

\n

Markdown content displayed in an annotation.

\n
\n
\n
\n
\n
\n

text

\n
\n

string

\n

The annotation's Markdown content.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

connectionEnvs

\n
\n

[object]

\n

A list of connections or connection groups used in the workflow.

\n
\n
\n
\n
\n
\n

connectionGroups

\n
\n

[object]

\n

The ConnectionEnv connectionGroups.

\n
\n
\n
\n
\n
\n

connectionGroupId [required]

\n
\n

string

\n

The ConnectionGroup connectionGroupId.

\n
\n \n
\n
\n
\n
\n
\n

label [required]

\n
\n

string

\n

The ConnectionGroup label.

\n
\n \n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

The ConnectionGroup tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

connections

\n
\n

[object]

\n

The ConnectionEnv connections.

\n
\n
\n
\n
\n
\n

connectionId [required]

\n
\n

string

\n

The Connection connectionId.

\n
\n \n
\n
\n
\n
\n
\n

label [required]

\n
\n

string

\n

The Connection label.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

env [required]

\n
\n

enum

\n

The definition of ConnectionEnvEnv object. \nAllowed enum values: default

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Unique identifier used to trigger workflows automatically in Datadog.

\n
\n \n
\n
\n
\n
\n
\n

inputSchema

\n
\n

object

\n

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

\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

The InputSchema parameters.

\n
\n
\n
\n
\n
\n

allowExtraValues

\n
\n

boolean

\n

The InputSchemaParameters allowExtraValues.

\n
\n \n
\n
\n
\n
\n
\n

allowedValues

\n
\n

\n

The InputSchemaParameters allowedValues.

\n
\n \n
\n
\n
\n
\n
\n

defaultValue

\n
\n

\n

The InputSchemaParameters defaultValue.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The InputSchemaParameters description.

\n
\n \n
\n
\n
\n
\n
\n

label

\n
\n

string

\n

The InputSchemaParameters label.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The InputSchemaParameters name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of InputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

outputSchema

\n
\n

object

\n

A list of output parameters for the workflow.

\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

The OutputSchema parameters.

\n
\n
\n
\n
\n
\n

defaultValue

\n
\n

\n

The OutputSchemaParameters defaultValue.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The OutputSchemaParameters description.

\n
\n \n
\n
\n
\n
\n
\n

label

\n
\n

string

\n

The OutputSchemaParameters label.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The OutputSchemaParameters name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of OutputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

\n

The OutputSchemaParameters value.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

A Step is a sub-component of a workflow. Each Step performs an action.

\n
\n
\n
\n
\n
\n

actionId [required]

\n
\n

string

\n

The unique identifier of an action.

\n
\n \n
\n
\n
\n
\n
\n

completionGate

\n
\n

object

\n

Used to create conditions before running subsequent actions.

\n
\n
\n
\n
\n
\n

completionCondition [required]

\n
\n

object

\n

The definition of CompletionCondition object.

\n
\n
\n
\n
\n
\n

operand1 [required]

\n
\n

\n

The CompletionCondition operand1.

\n
\n \n
\n
\n
\n
\n
\n

operand2

\n
\n

\n

The CompletionCondition operand2.

\n
\n \n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

The definition of CompletionConditionOperator object. \nAllowed 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

Show 2 more,OPERATOR_IS_EMPTY,OPERATOR_IS_NOT_EMPTY

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

retryStrategy [required]

\n
\n

object

\n

The definition of RetryStrategy object.

\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR

\n
\n \n
\n
\n
\n
\n
\n

linear [required]

\n
\n

object

\n

The definition of RetryStrategyLinear object.

\n
\n
\n
\n
\n
\n

interval [required]

\n
\n

string

\n

The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n

maxRetries [required]

\n
\n

int32

\n

The RetryStrategyLinear maxRetries.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

connectionLabel

\n
\n

string

\n

The unique identifier of a connection defined in the spec.

\n
\n \n
\n
\n
\n
\n
\n

display

\n
\n

object

\n

The position of a step on the workflow canvas. Omit display from every step to use\nautomatic layout, or provide it for every step to preserve a manual layout.

\n
\n
\n
\n
\n
\n

bounds

\n
\n

object

\n

The definition of StepDisplayBounds object.

\n
\n
\n
\n
\n
\n

x

\n
\n

double

\n

The bounds x.

\n
\n \n
\n
\n
\n
\n
\n

y

\n
\n

double

\n

The bounds y.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

errorHandlers

\n
\n

[object]

\n

The Step errorHandlers.

\n
\n
\n
\n
\n
\n

fallbackStepName [required]

\n
\n

string

\n

The ErrorHandler fallbackStepName.

\n
\n \n
\n
\n
\n
\n
\n

retryStrategy [required]

\n
\n

object

\n

The definition of RetryStrategy object.

\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR

\n
\n \n
\n
\n
\n
\n
\n

linear [required]

\n
\n

object

\n

The definition of RetryStrategyLinear object.

\n
\n
\n
\n
\n
\n

interval [required]

\n
\n

string

\n

The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n

maxRetries [required]

\n
\n

int32

\n

The RetryStrategyLinear maxRetries.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the step.

\n
\n \n
\n
\n
\n
\n
\n

outboundEdges

\n
\n

[object]

\n

A list of subsequent actions to run. This list is empty for a terminal step.

\n
\n
\n
\n
\n
\n

branchName [required]

\n
\n

string

\n

The OutboundEdge branchName.

\n
\n \n
\n
\n
\n
\n
\n

nextStepName [required]

\n
\n

string

\n

The OutboundEdge nextStepName.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

A list of inputs for an action.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The Parameter name.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

\n

The Parameter value.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

readinessGate

\n
\n

object

\n

Used to merge multiple branches into a single branch.

\n
\n
\n
\n
\n
\n

thresholdType [required]

\n
\n

enum

\n

The definition of ReadinessGateThresholdType object. \nAllowed enum values: ANY,ALL

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

triggers

\n
\n

[ <oneOf>]

\n

The list of triggers that activate this workflow. At least one trigger is required, and each trigger type may appear at most once.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

Schema for an agent-based trigger.

\n
\n
\n
\n
\n
\n

agentTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Schema for an API-based trigger.

\n
\n
\n
\n
\n
\n

apiTrigger [required]

\n
\n

object

\n

Trigger a workflow from an API request. The workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 3

\n
\n

object

\n

Schema for an App-based trigger.

\n
\n
\n
\n
\n
\n

appTrigger [required]

\n
\n

object

\n

Trigger a workflow from an App.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 4

\n
\n

object

\n

Schema for a Case-based trigger.

\n
\n
\n
\n
\n
\n

caseTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Case. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 5

\n
\n

object

\n

Schema for a Change Event-based trigger.

\n
\n
\n
\n
\n
\n

changeEventTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Change Event.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 6

\n
\n

object

\n

Schema for a Database Monitoring-based trigger.

\n
\n
\n
\n
\n
\n

databaseMonitoringTrigger [required]

\n
\n

object

\n

Trigger a workflow from Database Monitoring.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 7

\n
\n

object

\n

Schema for a Datastore-based trigger.

\n
\n
\n
\n
\n
\n

datastoreTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Datastore. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 8

\n
\n

object

\n

Schema for a Dashboard-based trigger.

\n
\n
\n
\n
\n
\n

dashboardTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Dashboard.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 9

\n
\n

object

\n

Schema for a Form-based trigger.

\n
\n
\n
\n
\n
\n

formTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Form.

\n
\n
\n
\n
\n
\n

formId

\n
\n

string

\n

The form UUID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 10

\n
\n

object

\n

Schema for a GitHub webhook-based trigger.

\n
\n
\n
\n
\n
\n

githubWebhookTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 11

\n
\n

object

\n

Schema for an incident declared trigger.

\n
\n
\n
\n
\n
\n

incidentCreatedTrigger [required]

\n
\n

object

\n

Trigger a workflow when an incident is declared.

\n
\n
\n
\n
\n
\n

incidentType

\n
\n

string

\n

The type of incident that triggers the workflow.

\n
\n \n
\n
\n
\n
\n
\n

tagCondition

\n
\n

object

\n

Conditions that determine which incidents trigger the workflow.

\n
\n
\n
\n
\n
\n

tagValues

\n
\n

[object]

\n

Incident tags and values used to filter matching incidents.

\n
\n
\n
\n
\n
\n

tag [required]

\n
\n

string

\n

The incident tag to match.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The accepted values for the incident tag.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 12

\n
\n

object

\n

Schema for an incident impact created trigger.

\n
\n
\n
\n
\n
\n

incidentImpactCreatedTrigger [required]

\n
\n

object

\n

Trigger a workflow when an impact is created for an incident.

\n
\n
\n
\n
\n
\n

executionLimit

\n
\n

object

\n

The maximum number of times to execute a workflow for an incident.

\n
\n
\n
\n
\n
\n

count [required]

\n
\n

int32

\n

The maximum number of workflow executions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

incidentType

\n
\n

string

\n

The type of incident that triggers the workflow.

\n
\n \n
\n
\n
\n
\n
\n

tagCondition

\n
\n

object

\n

Conditions that determine which incidents trigger the workflow.

\n
\n
\n
\n
\n
\n

tagValues

\n
\n

[object]

\n

Incident tags and values used to filter matching incidents.

\n
\n
\n
\n
\n
\n

tag [required]

\n
\n

string

\n

The incident tag to match.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The accepted values for the incident tag.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 13

\n
\n

object

\n

Schema for an incident impact updated trigger.

\n
\n
\n
\n
\n
\n

incidentImpactUpdatedTrigger [required]

\n
\n

object

\n

Trigger a workflow when an impact is updated for an incident.

\n
\n
\n
\n
\n
\n

executionLimit

\n
\n

object

\n

The maximum number of times to execute a workflow for an incident.

\n
\n
\n
\n
\n
\n

count [required]

\n
\n

int32

\n

The maximum number of workflow executions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

incidentType

\n
\n

string

\n

The type of incident that triggers the workflow.

\n
\n \n
\n
\n
\n
\n
\n

tagCondition

\n
\n

object

\n

Conditions that determine which incidents trigger the workflow.

\n
\n
\n
\n
\n
\n

tagValues

\n
\n

[object]

\n

Incident tags and values used to filter matching incidents.

\n
\n
\n
\n
\n
\n

tag [required]

\n
\n

string

\n

The incident tag to match.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The accepted values for the incident tag.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 14

\n
\n

object

\n

Schema for an incident postmortem updated trigger.

\n
\n
\n
\n
\n
\n

incidentPostmortemUpdatedTrigger [required]

\n
\n

object

\n

Trigger a workflow when a postmortem is updated for an incident.

\n
\n
\n
\n
\n
\n

executionLimit

\n
\n

object

\n

The maximum number of times to execute a workflow for an incident.

\n
\n
\n
\n
\n
\n

count [required]

\n
\n

int32

\n

The maximum number of workflow executions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

incidentType

\n
\n

string

\n

The type of incident that triggers the workflow.

\n
\n \n
\n
\n
\n
\n
\n

tagCondition

\n
\n

object

\n

Conditions that determine which incidents trigger the workflow.

\n
\n
\n
\n
\n
\n

tagValues

\n
\n

[object]

\n

Incident tags and values used to filter matching incidents.

\n
\n
\n
\n
\n
\n

tag [required]

\n
\n

string

\n

The incident tag to match.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The accepted values for the incident tag.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 15

\n
\n

object

\n

Schema for an incident responder created trigger.

\n
\n
\n
\n
\n
\n

incidentResponderCreatedTrigger [required]

\n
\n

object

\n

Trigger a workflow when a responder is created for an incident.

\n
\n
\n
\n
\n
\n

executionLimit

\n
\n

object

\n

The maximum number of times to execute a workflow for an incident.

\n
\n
\n
\n
\n
\n

count [required]

\n
\n

int32

\n

The maximum number of workflow executions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

incidentType

\n
\n

string

\n

The type of incident that triggers the workflow.

\n
\n \n
\n
\n
\n
\n
\n

tagCondition

\n
\n

object

\n

Conditions that determine which incidents trigger the workflow.

\n
\n
\n
\n
\n
\n

tagValues

\n
\n

[object]

\n

Incident tags and values used to filter matching incidents.

\n
\n
\n
\n
\n
\n

tag [required]

\n
\n

string

\n

The incident tag to match.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The accepted values for the incident tag.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 16

\n
\n

object

\n

Schema for an incident declared or updated trigger.

\n
\n
\n
\n
\n
\n

incidentSavedTrigger [required]

\n
\n

object

\n

Trigger a workflow when an incident is declared or updated.

\n
\n
\n
\n
\n
\n

executionLimit

\n
\n

object

\n

The maximum number of times to execute a workflow for an incident.

\n
\n
\n
\n
\n
\n

count [required]

\n
\n

int32

\n

The maximum number of workflow executions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

incidentType

\n
\n

string

\n

The type of incident that triggers the workflow.

\n
\n \n
\n
\n
\n
\n
\n

serialExecution

\n
\n

object

\n

Whether to execute the workflow serially for an incident.

\n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Whether serial execution is enabled.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tagCondition

\n
\n

object

\n

Conditions that determine which incidents trigger the workflow.

\n
\n
\n
\n
\n
\n

tagValues

\n
\n

[object]

\n

Incident tags and values used to filter matching incidents.

\n
\n
\n
\n
\n
\n

tag [required]

\n
\n

string

\n

The incident tag to match.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The accepted values for the incident tag.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 17

\n
\n

object

\n

Schema for an incident schedule trigger.

\n
\n
\n
\n
\n
\n

incidentScheduleTrigger [required]

\n
\n

object

\n

Trigger a workflow on a schedule for an incident.

\n
\n
\n
\n
\n
\n

incidentType

\n
\n

string

\n

The type of incident that triggers the workflow.

\n
\n \n
\n
\n
\n
\n
\n

rrule [required]

\n
\n

string

\n

The recurrence rule for the schedule, expressed as an iCalendar RRULE string.

\n
\n \n
\n
\n
\n
\n
\n

tagCondition

\n
\n

object

\n

Conditions that determine which incidents trigger the workflow.

\n
\n
\n
\n
\n
\n

tagValues

\n
\n

[object]

\n

Incident tags and values used to filter matching incidents.

\n
\n
\n
\n
\n
\n

tag [required]

\n
\n

string

\n

The incident tag to match.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The accepted values for the incident tag.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 18

\n
\n

object

\n

Schema for an incident-based trigger.

\n
\n
\n
\n
\n
\n

incidentTrigger [required]

\n
\n

object

\n

Trigger a workflow from an incident. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

version

\n
\n

string

\n

Version of the incident manual trigger.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 19

\n
\n

object

\n

Schema for a Monitor-based trigger.

\n
\n
\n
\n
\n
\n

monitorTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Monitor. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 20

\n
\n

object

\n

Schema for a Notebook-based trigger.

\n
\n
\n
\n
\n
\n

notebookTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Notebook.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 21

\n
\n

object

\n

Schema for an On-Call-based trigger.

\n
\n
\n
\n
\n
\n

onCallTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 22

\n
\n

object

\n

Schema for a Schedule-based trigger.

\n
\n
\n
\n
\n
\n

scheduleTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Schedule. The workflow must be published.

\n
\n
\n
\n
\n
\n

overlapBehavior

\n
\n

enum

\n

Controls whether a scheduled workflow run may start while another instance is still running. \nAllowed enum values: EXCLUSIVE_RUN,OVERLAP_ALLOWED

default: EXCLUSIVE_RUN

\n
\n \n
\n
\n
\n
\n
\n

rruleExpression [required]

\n
\n

string

\n

Recurrence rule expression for scheduling.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 23

\n
\n

object

\n

Schema for a Security-based trigger.

\n
\n
\n
\n
\n
\n

securityTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Security Signal or Finding. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 24

\n
\n

object

\n

Schema for a Self Service-based trigger.

\n
\n
\n
\n
\n
\n

selfServiceTrigger [required]

\n
\n

object

\n

Trigger a workflow from Self Service.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 25

\n
\n

object

\n

Schema for a Slack-based trigger.

\n
\n
\n
\n
\n
\n

slackTrigger [required]

\n
\n

object

\n

Trigger a workflow from Slack. The workflow must be published.

\n
\n
\n
\n
\n
\n

reactionTriggers

\n
\n

[object]

\n

Slack emoji reactions that trigger the workflow.

\n
\n
\n
\n
\n
\n

reactionEmoji [required]

\n
\n

string

\n

The Slack emoji reaction name.

\n
\n \n
\n
\n
\n
\n
\n

teamId [required]

\n
\n

string

\n

The Slack workspace ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 26

\n
\n

object

\n

Schema for a Software Catalog-based trigger.

\n
\n
\n
\n
\n
\n

softwareCatalogTrigger [required]

\n
\n

object

\n

Trigger a workflow from Software Catalog.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 27

\n
\n

object

\n

Schema for a Workflow-based trigger.

\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n

workflowTrigger [required]

\n
\n

object

\n

Trigger a workflow from the Datadog UI. When present, this must be the workflow's only trigger.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

date-time

\n

When the workflow was last updated.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The workflow identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The definition of WorkflowDataRelationships object.

\n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

The definition of WorkflowUserRelationship object.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of WorkflowUserRelationshipData object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

owner

\n
\n

object

\n

The definition of WorkflowUserRelationship object.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of WorkflowUserRelationshipData object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

runAs

\n
\n

object

\n

The service account used to run the workflow. Present when runAsUserMode is service_account.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of WorkflowUserRelationshipData object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowDataType object. \nAllowed enum values: workflows

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -1015,9 +1007,6 @@ "description": "string", "name": "string", "published": false, - "runAs": { - "type": "owner" - }, "runAsUserMode": "owner", "spec": { "annotations": [ @@ -1151,8 +1140,7 @@ ] }, "tags": [], - "updatedAt": "2019-09-19T10:00:00.000Z", - "webhookSecret": "string" + "updatedAt": "2019-09-19T10:00:00.000Z" }, "id": "string", "relationships": { @@ -1178,7 +1166,7 @@ "type": "workflows" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Data related to the workflow being updated.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The definition of WorkflowDataUpdateAttributes object.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

When the workflow was created.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

published

\n
\n

boolean

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

runAs

\n
\n

 <oneOf>

\n

Identity used to run the workflow.

\n
\n
\n
\n
\n
\n

<type=owner>

\n
\n

object

\n

Run the workflow as its owner.

\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The owner run-as type. \nAllowed enum values: owner

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=service_account>

\n
\n

object

\n

Run the workflow as a service account.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The service account identifier.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The service account run-as type. \nAllowed enum values: service_account

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

<type=initiator>

\n
\n

object

\n

Run the workflow as the user who initiates the execution.

\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The initiator run-as type. \nAllowed enum values: initiator

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

runAsUserMode

\n
\n

enum

\n

The effective type of identity used to run the workflow. \nAllowed enum values: owner,service_account,initiator

\n
\n \n
\n
\n
\n
\n
\n

spec

\n
\n

object

\n

A complete Workflow Automation definition, including its triggers, steps, and connections.

\n
\n
\n
\n
\n
\n

annotations

\n
\n

[object]

\n

Up to 100 text annotations displayed on the workflow canvas.

\n
\n
\n
\n
\n
\n

display [required]

\n
\n

object

\n

The annotation's position and size on the workflow canvas.

\n
\n
\n
\n
\n
\n

bounds

\n
\n

object

\n

Canvas coordinates and dimensions for an annotation on the workflow canvas.

\n
\n
\n
\n
\n
\n

height

\n
\n

double

\n

The annotation's height on the canvas.

\n
\n \n
\n
\n
\n
\n
\n

width

\n
\n

double

\n

The annotation's width on the canvas.

\n
\n \n
\n
\n
\n
\n
\n

x

\n
\n

double

\n

The annotation's horizontal canvas coordinate.

\n
\n \n
\n
\n
\n
\n
\n

y

\n
\n

double

\n

The annotation's vertical canvas coordinate.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of this annotation within the workflow.

\n
\n \n
\n
\n
\n
\n
\n

markdownTextAnnotation [required]

\n
\n

object

\n

Markdown content displayed in an annotation.

\n
\n
\n
\n
\n
\n

text

\n
\n

string

\n

The annotation's Markdown content.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

connectionEnvs

\n
\n

[object]

\n

A list of connections or connection groups used in the workflow.

\n
\n
\n
\n
\n
\n

connectionGroups

\n
\n

[object]

\n

The ConnectionEnv connectionGroups.

\n
\n
\n
\n
\n
\n

connectionGroupId [required]

\n
\n

string

\n

The ConnectionGroup connectionGroupId.

\n
\n \n
\n
\n
\n
\n
\n

label [required]

\n
\n

string

\n

The ConnectionGroup label.

\n
\n \n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

The ConnectionGroup tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

connections

\n
\n

[object]

\n

The ConnectionEnv connections.

\n
\n
\n
\n
\n
\n

connectionId [required]

\n
\n

string

\n

The Connection connectionId.

\n
\n \n
\n
\n
\n
\n
\n

label [required]

\n
\n

string

\n

The Connection label.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

env [required]

\n
\n

enum

\n

The definition of ConnectionEnvEnv object. \nAllowed enum values: default

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Unique identifier used to trigger workflows automatically in Datadog.

\n
\n \n
\n
\n
\n
\n
\n

inputSchema

\n
\n

object

\n

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

\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

The InputSchema parameters.

\n
\n
\n
\n
\n
\n

allowExtraValues

\n
\n

boolean

\n

The InputSchemaParameters allowExtraValues.

\n
\n \n
\n
\n
\n
\n
\n

allowedValues

\n
\n

\n

The InputSchemaParameters allowedValues.

\n
\n \n
\n
\n
\n
\n
\n

defaultValue

\n
\n

\n

The InputSchemaParameters defaultValue.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The InputSchemaParameters description.

\n
\n \n
\n
\n
\n
\n
\n

label

\n
\n

string

\n

The InputSchemaParameters label.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The InputSchemaParameters name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of InputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

outputSchema

\n
\n

object

\n

A list of output parameters for the workflow.

\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

The OutputSchema parameters.

\n
\n
\n
\n
\n
\n

defaultValue

\n
\n

\n

The OutputSchemaParameters defaultValue.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The OutputSchemaParameters description.

\n
\n \n
\n
\n
\n
\n
\n

label

\n
\n

string

\n

The OutputSchemaParameters label.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The OutputSchemaParameters name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of OutputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

\n

The OutputSchemaParameters value.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

A Step is a sub-component of a workflow. Each Step performs an action.

\n
\n
\n
\n
\n
\n

actionId [required]

\n
\n

string

\n

The unique identifier of an action.

\n
\n \n
\n
\n
\n
\n
\n

completionGate

\n
\n

object

\n

Used to create conditions before running subsequent actions.

\n
\n
\n
\n
\n
\n

completionCondition [required]

\n
\n

object

\n

The definition of CompletionCondition object.

\n
\n
\n
\n
\n
\n

operand1 [required]

\n
\n

\n

The CompletionCondition operand1.

\n
\n \n
\n
\n
\n
\n
\n

operand2

\n
\n

\n

The CompletionCondition operand2.

\n
\n \n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

The definition of CompletionConditionOperator object. \nAllowed 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

Show 2 more,OPERATOR_IS_EMPTY,OPERATOR_IS_NOT_EMPTY

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

retryStrategy [required]

\n
\n

object

\n

The definition of RetryStrategy object.

\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR

\n
\n \n
\n
\n
\n
\n
\n

linear [required]

\n
\n

object

\n

The definition of RetryStrategyLinear object.

\n
\n
\n
\n
\n
\n

interval [required]

\n
\n

string

\n

The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n

maxRetries [required]

\n
\n

int32

\n

The RetryStrategyLinear maxRetries.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

connectionLabel

\n
\n

string

\n

The unique identifier of a connection defined in the spec.

\n
\n \n
\n
\n
\n
\n
\n

display

\n
\n

object

\n

The position of a step on the workflow canvas. Omit display from every step to use\nautomatic layout, or provide it for every step to preserve a manual layout.

\n
\n
\n
\n
\n
\n

bounds

\n
\n

object

\n

The definition of StepDisplayBounds object.

\n
\n
\n
\n
\n
\n

x

\n
\n

double

\n

The bounds x.

\n
\n \n
\n
\n
\n
\n
\n

y

\n
\n

double

\n

The bounds y.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

errorHandlers

\n
\n

[object]

\n

The Step errorHandlers.

\n
\n
\n
\n
\n
\n

fallbackStepName [required]

\n
\n

string

\n

The ErrorHandler fallbackStepName.

\n
\n \n
\n
\n
\n
\n
\n

retryStrategy [required]

\n
\n

object

\n

The definition of RetryStrategy object.

\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR

\n
\n \n
\n
\n
\n
\n
\n

linear [required]

\n
\n

object

\n

The definition of RetryStrategyLinear object.

\n
\n
\n
\n
\n
\n

interval [required]

\n
\n

string

\n

The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n

maxRetries [required]

\n
\n

int32

\n

The RetryStrategyLinear maxRetries.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the step.

\n
\n \n
\n
\n
\n
\n
\n

outboundEdges

\n
\n

[object]

\n

A list of subsequent actions to run. This list is empty for a terminal step.

\n
\n
\n
\n
\n
\n

branchName [required]

\n
\n

string

\n

The OutboundEdge branchName.

\n
\n \n
\n
\n
\n
\n
\n

nextStepName [required]

\n
\n

string

\n

The OutboundEdge nextStepName.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

A list of inputs for an action.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The Parameter name.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

\n

The Parameter value.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

readinessGate

\n
\n

object

\n

Used to merge multiple branches into a single branch.

\n
\n
\n
\n
\n
\n

thresholdType [required]

\n
\n

enum

\n

The definition of ReadinessGateThresholdType object. \nAllowed enum values: ANY,ALL

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

triggers

\n
\n

[ <oneOf>]

\n

The list of triggers that activate this workflow. At least one trigger is required, and each trigger type may appear at most once.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

Schema for an agent-based trigger.

\n
\n
\n
\n
\n
\n

agentTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Schema for an API-based trigger.

\n
\n
\n
\n
\n
\n

apiTrigger [required]

\n
\n

object

\n

Trigger a workflow from an API request. The workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 3

\n
\n

object

\n

Schema for an App-based trigger.

\n
\n
\n
\n
\n
\n

appTrigger [required]

\n
\n

object

\n

Trigger a workflow from an App.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 4

\n
\n

object

\n

Schema for a Case-based trigger.

\n
\n
\n
\n
\n
\n

caseTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Case. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 5

\n
\n

object

\n

Schema for a Change Event-based trigger.

\n
\n
\n
\n
\n
\n

changeEventTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Change Event.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 6

\n
\n

object

\n

Schema for a Database Monitoring-based trigger.

\n
\n
\n
\n
\n
\n

databaseMonitoringTrigger [required]

\n
\n

object

\n

Trigger a workflow from Database Monitoring.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 7

\n
\n

object

\n

Schema for a Datastore-based trigger.

\n
\n
\n
\n
\n
\n

datastoreTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Datastore. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 8

\n
\n

object

\n

Schema for a Dashboard-based trigger.

\n
\n
\n
\n
\n
\n

dashboardTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Dashboard.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 9

\n
\n

object

\n

Schema for a Form-based trigger.

\n
\n
\n
\n
\n
\n

formTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Form.

\n
\n
\n
\n
\n
\n

formId

\n
\n

string

\n

The form UUID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 10

\n
\n

object

\n

Schema for a GitHub webhook-based trigger.

\n
\n
\n
\n
\n
\n

githubWebhookTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 11

\n
\n

object

\n

Schema for an incident declared trigger.

\n
\n
\n
\n
\n
\n

incidentCreatedTrigger [required]

\n
\n

object

\n

Trigger a workflow when an incident is declared.

\n
\n
\n
\n
\n
\n

incidentType

\n
\n

string

\n

The type of incident that triggers the workflow.

\n
\n \n
\n
\n
\n
\n
\n

tagCondition

\n
\n

object

\n

Conditions that determine which incidents trigger the workflow.

\n
\n
\n
\n
\n
\n

tagValues

\n
\n

[object]

\n

Incident tags and values used to filter matching incidents.

\n
\n
\n
\n
\n
\n

tag [required]

\n
\n

string

\n

The incident tag to match.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The accepted values for the incident tag.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 12

\n
\n

object

\n

Schema for an incident impact created trigger.

\n
\n
\n
\n
\n
\n

incidentImpactCreatedTrigger [required]

\n
\n

object

\n

Trigger a workflow when an impact is created for an incident.

\n
\n
\n
\n
\n
\n

executionLimit

\n
\n

object

\n

The maximum number of times to execute a workflow for an incident.

\n
\n
\n
\n
\n
\n

count [required]

\n
\n

int32

\n

The maximum number of workflow executions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

incidentType

\n
\n

string

\n

The type of incident that triggers the workflow.

\n
\n \n
\n
\n
\n
\n
\n

tagCondition

\n
\n

object

\n

Conditions that determine which incidents trigger the workflow.

\n
\n
\n
\n
\n
\n

tagValues

\n
\n

[object]

\n

Incident tags and values used to filter matching incidents.

\n
\n
\n
\n
\n
\n

tag [required]

\n
\n

string

\n

The incident tag to match.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The accepted values for the incident tag.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 13

\n
\n

object

\n

Schema for an incident impact updated trigger.

\n
\n
\n
\n
\n
\n

incidentImpactUpdatedTrigger [required]

\n
\n

object

\n

Trigger a workflow when an impact is updated for an incident.

\n
\n
\n
\n
\n
\n

executionLimit

\n
\n

object

\n

The maximum number of times to execute a workflow for an incident.

\n
\n
\n
\n
\n
\n

count [required]

\n
\n

int32

\n

The maximum number of workflow executions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

incidentType

\n
\n

string

\n

The type of incident that triggers the workflow.

\n
\n \n
\n
\n
\n
\n
\n

tagCondition

\n
\n

object

\n

Conditions that determine which incidents trigger the workflow.

\n
\n
\n
\n
\n
\n

tagValues

\n
\n

[object]

\n

Incident tags and values used to filter matching incidents.

\n
\n
\n
\n
\n
\n

tag [required]

\n
\n

string

\n

The incident tag to match.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The accepted values for the incident tag.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 14

\n
\n

object

\n

Schema for an incident postmortem updated trigger.

\n
\n
\n
\n
\n
\n

incidentPostmortemUpdatedTrigger [required]

\n
\n

object

\n

Trigger a workflow when a postmortem is updated for an incident.

\n
\n
\n
\n
\n
\n

executionLimit

\n
\n

object

\n

The maximum number of times to execute a workflow for an incident.

\n
\n
\n
\n
\n
\n

count [required]

\n
\n

int32

\n

The maximum number of workflow executions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

incidentType

\n
\n

string

\n

The type of incident that triggers the workflow.

\n
\n \n
\n
\n
\n
\n
\n

tagCondition

\n
\n

object

\n

Conditions that determine which incidents trigger the workflow.

\n
\n
\n
\n
\n
\n

tagValues

\n
\n

[object]

\n

Incident tags and values used to filter matching incidents.

\n
\n
\n
\n
\n
\n

tag [required]

\n
\n

string

\n

The incident tag to match.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The accepted values for the incident tag.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 15

\n
\n

object

\n

Schema for an incident responder created trigger.

\n
\n
\n
\n
\n
\n

incidentResponderCreatedTrigger [required]

\n
\n

object

\n

Trigger a workflow when a responder is created for an incident.

\n
\n
\n
\n
\n
\n

executionLimit

\n
\n

object

\n

The maximum number of times to execute a workflow for an incident.

\n
\n
\n
\n
\n
\n

count [required]

\n
\n

int32

\n

The maximum number of workflow executions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

incidentType

\n
\n

string

\n

The type of incident that triggers the workflow.

\n
\n \n
\n
\n
\n
\n
\n

tagCondition

\n
\n

object

\n

Conditions that determine which incidents trigger the workflow.

\n
\n
\n
\n
\n
\n

tagValues

\n
\n

[object]

\n

Incident tags and values used to filter matching incidents.

\n
\n
\n
\n
\n
\n

tag [required]

\n
\n

string

\n

The incident tag to match.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The accepted values for the incident tag.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 16

\n
\n

object

\n

Schema for an incident declared or updated trigger.

\n
\n
\n
\n
\n
\n

incidentSavedTrigger [required]

\n
\n

object

\n

Trigger a workflow when an incident is declared or updated.

\n
\n
\n
\n
\n
\n

executionLimit

\n
\n

object

\n

The maximum number of times to execute a workflow for an incident.

\n
\n
\n
\n
\n
\n

count [required]

\n
\n

int32

\n

The maximum number of workflow executions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

incidentType

\n
\n

string

\n

The type of incident that triggers the workflow.

\n
\n \n
\n
\n
\n
\n
\n

serialExecution

\n
\n

object

\n

Whether to execute the workflow serially for an incident.

\n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Whether serial execution is enabled.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tagCondition

\n
\n

object

\n

Conditions that determine which incidents trigger the workflow.

\n
\n
\n
\n
\n
\n

tagValues

\n
\n

[object]

\n

Incident tags and values used to filter matching incidents.

\n
\n
\n
\n
\n
\n

tag [required]

\n
\n

string

\n

The incident tag to match.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The accepted values for the incident tag.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 17

\n
\n

object

\n

Schema for an incident schedule trigger.

\n
\n
\n
\n
\n
\n

incidentScheduleTrigger [required]

\n
\n

object

\n

Trigger a workflow on a schedule for an incident.

\n
\n
\n
\n
\n
\n

incidentType

\n
\n

string

\n

The type of incident that triggers the workflow.

\n
\n \n
\n
\n
\n
\n
\n

rrule [required]

\n
\n

string

\n

The recurrence rule for the schedule, expressed as an iCalendar RRULE string.

\n
\n \n
\n
\n
\n
\n
\n

tagCondition

\n
\n

object

\n

Conditions that determine which incidents trigger the workflow.

\n
\n
\n
\n
\n
\n

tagValues

\n
\n

[object]

\n

Incident tags and values used to filter matching incidents.

\n
\n
\n
\n
\n
\n

tag [required]

\n
\n

string

\n

The incident tag to match.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The accepted values for the incident tag.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 18

\n
\n

object

\n

Schema for an incident-based trigger.

\n
\n
\n
\n
\n
\n

incidentTrigger [required]

\n
\n

object

\n

Trigger a workflow from an incident. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

version

\n
\n

string

\n

Version of the incident manual trigger.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 19

\n
\n

object

\n

Schema for a Monitor-based trigger.

\n
\n
\n
\n
\n
\n

monitorTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Monitor. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 20

\n
\n

object

\n

Schema for a Notebook-based trigger.

\n
\n
\n
\n
\n
\n

notebookTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Notebook.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 21

\n
\n

object

\n

Schema for an On-Call-based trigger.

\n
\n
\n
\n
\n
\n

onCallTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 22

\n
\n

object

\n

Schema for a Schedule-based trigger.

\n
\n
\n
\n
\n
\n

scheduleTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Schedule. The workflow must be published.

\n
\n
\n
\n
\n
\n

overlapBehavior

\n
\n

enum

\n

Controls whether a scheduled workflow run may start while another instance is still running. \nAllowed enum values: EXCLUSIVE_RUN,OVERLAP_ALLOWED

default: EXCLUSIVE_RUN

\n
\n \n
\n
\n
\n
\n
\n

rruleExpression [required]

\n
\n

string

\n

Recurrence rule expression for scheduling.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 23

\n
\n

object

\n

Schema for a Security-based trigger.

\n
\n
\n
\n
\n
\n

securityTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Security Signal or Finding. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 24

\n
\n

object

\n

Schema for a Self Service-based trigger.

\n
\n
\n
\n
\n
\n

selfServiceTrigger [required]

\n
\n

object

\n

Trigger a workflow from Self Service.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 25

\n
\n

object

\n

Schema for a Slack-based trigger.

\n
\n
\n
\n
\n
\n

slackTrigger [required]

\n
\n

object

\n

Trigger a workflow from Slack. The workflow must be published.

\n
\n
\n
\n
\n
\n

reactionTriggers

\n
\n

[object]

\n

Slack emoji reactions that trigger the workflow.

\n
\n
\n
\n
\n
\n

reactionEmoji [required]

\n
\n

string

\n

The Slack emoji reaction name.

\n
\n \n
\n
\n
\n
\n
\n

teamId [required]

\n
\n

string

\n

The Slack workspace ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 26

\n
\n

object

\n

Schema for a Software Catalog-based trigger.

\n
\n
\n
\n
\n
\n

softwareCatalogTrigger [required]

\n
\n

object

\n

Trigger a workflow from Software Catalog.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 27

\n
\n

object

\n

Schema for a Workflow-based trigger.

\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n

workflowTrigger [required]

\n
\n

object

\n

Trigger a workflow from the Datadog UI. When present, this must be the workflow's only trigger.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

date-time

\n

When the workflow was last updated.

\n
\n \n
\n
\n
\n
\n
\n

webhookSecret

\n
\n

string

\n

If a Webhook trigger is defined on this workflow, a webhookSecret is required and should be provided here.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The workflow identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The definition of WorkflowDataRelationships object.

\n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

The definition of WorkflowUserRelationship object.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of WorkflowUserRelationshipData object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

owner

\n
\n

object

\n

The definition of WorkflowUserRelationship object.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of WorkflowUserRelationshipData object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

runAs

\n
\n

object

\n

The service account used to run the workflow. Present when runAsUserMode is service_account.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of WorkflowUserRelationshipData object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowDataType object. \nAllowed enum values: workflows

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

Data related to the workflow being updated.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The definition of WorkflowDataUpdateAttributes object.

\n
\n
\n
\n
\n
\n

createdAt

\n
\n

date-time

\n

When the workflow was created.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

Description of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Name of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

published

\n
\n

boolean

\n

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.

\n
\n \n
\n
\n
\n
\n
\n

runAsUserMode

\n
\n

enum

\n

The effective type of identity used to run the workflow. \nAllowed enum values: owner,service_account,initiator

\n
\n \n
\n
\n
\n
\n
\n

spec

\n
\n

object

\n

A complete Workflow Automation definition, including its triggers, steps, and connections.

\n
\n
\n
\n
\n
\n

annotations

\n
\n

[object]

\n

Up to 100 text annotations displayed on the workflow canvas.

\n
\n
\n
\n
\n
\n

display [required]

\n
\n

object

\n

The annotation's position and size on the workflow canvas.

\n
\n
\n
\n
\n
\n

bounds

\n
\n

object

\n

Canvas coordinates and dimensions for an annotation on the workflow canvas.

\n
\n
\n
\n
\n
\n

height

\n
\n

double

\n

The annotation's height on the canvas.

\n
\n \n
\n
\n
\n
\n
\n

width

\n
\n

double

\n

The annotation's width on the canvas.

\n
\n \n
\n
\n
\n
\n
\n

x

\n
\n

double

\n

The annotation's horizontal canvas coordinate.

\n
\n \n
\n
\n
\n
\n
\n

y

\n
\n

double

\n

The annotation's vertical canvas coordinate.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of this annotation within the workflow.

\n
\n \n
\n
\n
\n
\n
\n

markdownTextAnnotation [required]

\n
\n

object

\n

Markdown content displayed in an annotation.

\n
\n
\n
\n
\n
\n

text

\n
\n

string

\n

The annotation's Markdown content.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

connectionEnvs

\n
\n

[object]

\n

A list of connections or connection groups used in the workflow.

\n
\n
\n
\n
\n
\n

connectionGroups

\n
\n

[object]

\n

The ConnectionEnv connectionGroups.

\n
\n
\n
\n
\n
\n

connectionGroupId [required]

\n
\n

string

\n

The ConnectionGroup connectionGroupId.

\n
\n \n
\n
\n
\n
\n
\n

label [required]

\n
\n

string

\n

The ConnectionGroup label.

\n
\n \n
\n
\n
\n
\n
\n

tags [required]

\n
\n

[string]

\n

The ConnectionGroup tags.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

connections

\n
\n

[object]

\n

The ConnectionEnv connections.

\n
\n
\n
\n
\n
\n

connectionId [required]

\n
\n

string

\n

The Connection connectionId.

\n
\n \n
\n
\n
\n
\n
\n

label [required]

\n
\n

string

\n

The Connection label.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

env [required]

\n
\n

enum

\n

The definition of ConnectionEnvEnv object. \nAllowed enum values: default

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

handle

\n
\n

string

\n

Unique identifier used to trigger workflows automatically in Datadog.

\n
\n \n
\n
\n
\n
\n
\n

inputSchema

\n
\n

object

\n

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

\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

The InputSchema parameters.

\n
\n
\n
\n
\n
\n

allowExtraValues

\n
\n

boolean

\n

The InputSchemaParameters allowExtraValues.

\n
\n \n
\n
\n
\n
\n
\n

allowedValues

\n
\n

\n

The InputSchemaParameters allowedValues.

\n
\n \n
\n
\n
\n
\n
\n

defaultValue

\n
\n

\n

The InputSchemaParameters defaultValue.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The InputSchemaParameters description.

\n
\n \n
\n
\n
\n
\n
\n

label

\n
\n

string

\n

The InputSchemaParameters label.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The InputSchemaParameters name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of InputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

outputSchema

\n
\n

object

\n

A list of output parameters for the workflow.

\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

The OutputSchema parameters.

\n
\n
\n
\n
\n
\n

defaultValue

\n
\n

\n

The OutputSchemaParameters defaultValue.

\n
\n \n
\n
\n
\n
\n
\n

description

\n
\n

string

\n

The OutputSchemaParameters description.

\n
\n \n
\n
\n
\n
\n
\n

label

\n
\n

string

\n

The OutputSchemaParameters label.

\n
\n \n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The OutputSchemaParameters name.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of OutputSchemaParametersType object. \nAllowed enum values: STRING,NUMBER,BOOLEAN,OBJECT,ARRAY_STRING,ARRAY_NUMBER,ARRAY_BOOLEAN,ARRAY_OBJECT

\n
\n \n
\n
\n
\n
\n
\n

value

\n
\n

\n

The OutputSchemaParameters value.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

steps

\n
\n

[object]

\n

A Step is a sub-component of a workflow. Each Step performs an action.

\n
\n
\n
\n
\n
\n

actionId [required]

\n
\n

string

\n

The unique identifier of an action.

\n
\n \n
\n
\n
\n
\n
\n

completionGate

\n
\n

object

\n

Used to create conditions before running subsequent actions.

\n
\n
\n
\n
\n
\n

completionCondition [required]

\n
\n

object

\n

The definition of CompletionCondition object.

\n
\n
\n
\n
\n
\n

operand1 [required]

\n
\n

\n

The CompletionCondition operand1.

\n
\n \n
\n
\n
\n
\n
\n

operand2

\n
\n

\n

The CompletionCondition operand2.

\n
\n \n
\n
\n
\n
\n
\n

operator [required]

\n
\n

enum

\n

The definition of CompletionConditionOperator object. \nAllowed 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

Show 2 more,OPERATOR_IS_EMPTY,OPERATOR_IS_NOT_EMPTY

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

retryStrategy [required]

\n
\n

object

\n

The definition of RetryStrategy object.

\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR

\n
\n \n
\n
\n
\n
\n
\n

linear [required]

\n
\n

object

\n

The definition of RetryStrategyLinear object.

\n
\n
\n
\n
\n
\n

interval [required]

\n
\n

string

\n

The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n

maxRetries [required]

\n
\n

int32

\n

The RetryStrategyLinear maxRetries.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

connectionLabel

\n
\n

string

\n

The unique identifier of a connection defined in the spec.

\n
\n \n
\n
\n
\n
\n
\n

display

\n
\n

object

\n

The position of a step on the workflow canvas. Omit display from every step to use\nautomatic layout, or provide it for every step to preserve a manual layout.

\n
\n
\n
\n
\n
\n

bounds

\n
\n

object

\n

The definition of StepDisplayBounds object.

\n
\n
\n
\n
\n
\n

x

\n
\n

double

\n

The bounds x.

\n
\n \n
\n
\n
\n
\n
\n

y

\n
\n

double

\n

The bounds y.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

errorHandlers

\n
\n

[object]

\n

The Step errorHandlers.

\n
\n
\n
\n
\n
\n

fallbackStepName [required]

\n
\n

string

\n

The ErrorHandler fallbackStepName.

\n
\n \n
\n
\n
\n
\n
\n

retryStrategy [required]

\n
\n

object

\n

The definition of RetryStrategy object.

\n
\n
\n
\n
\n
\n

kind [required]

\n
\n

enum

\n

The definition of RetryStrategyKind object. \nAllowed enum values: RETRY_STRATEGY_LINEAR

\n
\n \n
\n
\n
\n
\n
\n

linear [required]

\n
\n

object

\n

The definition of RetryStrategyLinear object.

\n
\n
\n
\n
\n
\n

interval [required]

\n
\n

string

\n

The RetryStrategyLinear interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n

maxRetries [required]

\n
\n

int32

\n

The RetryStrategyLinear maxRetries.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

Name of the step.

\n
\n \n
\n
\n
\n
\n
\n

outboundEdges

\n
\n

[object]

\n

A list of subsequent actions to run. This list is empty for a terminal step.

\n
\n
\n
\n
\n
\n

branchName [required]

\n
\n

string

\n

The OutboundEdge branchName.

\n
\n \n
\n
\n
\n
\n
\n

nextStepName [required]

\n
\n

string

\n

The OutboundEdge nextStepName.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

parameters

\n
\n

[object]

\n

A list of inputs for an action.

\n
\n
\n
\n
\n
\n

name [required]

\n
\n

string

\n

The Parameter name.

\n
\n \n
\n
\n
\n
\n
\n

value [required]

\n
\n

\n

The Parameter value.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

readinessGate

\n
\n

object

\n

Used to merge multiple branches into a single branch.

\n
\n
\n
\n
\n
\n

thresholdType [required]

\n
\n

enum

\n

The definition of ReadinessGateThresholdType object. \nAllowed enum values: ANY,ALL

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

triggers

\n
\n

[ <oneOf>]

\n

The list of triggers that activate this workflow. At least one trigger is required, and each trigger type may appear at most once.

\n
\n
\n
\n
\n
\n

Object 1

\n
\n

object

\n

Schema for an agent-based trigger.

\n
\n
\n
\n
\n
\n

agentTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 2

\n
\n

object

\n

Schema for an API-based trigger.

\n
\n
\n
\n
\n
\n

apiTrigger [required]

\n
\n

object

\n

Trigger a workflow from an API request. The workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 3

\n
\n

object

\n

Schema for an App-based trigger.

\n
\n
\n
\n
\n
\n

appTrigger [required]

\n
\n

object

\n

Trigger a workflow from an App.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 4

\n
\n

object

\n

Schema for a Case-based trigger.

\n
\n
\n
\n
\n
\n

caseTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Case. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 5

\n
\n

object

\n

Schema for a Change Event-based trigger.

\n
\n
\n
\n
\n
\n

changeEventTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Change Event.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 6

\n
\n

object

\n

Schema for a Database Monitoring-based trigger.

\n
\n
\n
\n
\n
\n

databaseMonitoringTrigger [required]

\n
\n

object

\n

Trigger a workflow from Database Monitoring.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 7

\n
\n

object

\n

Schema for a Datastore-based trigger.

\n
\n
\n
\n
\n
\n

datastoreTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Datastore. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 8

\n
\n

object

\n

Schema for a Dashboard-based trigger.

\n
\n
\n
\n
\n
\n

dashboardTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Dashboard.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 9

\n
\n

object

\n

Schema for a Form-based trigger.

\n
\n
\n
\n
\n
\n

formTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Form.

\n
\n
\n
\n
\n
\n

formId

\n
\n

string

\n

The form UUID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 10

\n
\n

object

\n

Schema for a GitHub webhook-based trigger.

\n
\n
\n
\n
\n
\n

githubWebhookTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 11

\n
\n

object

\n

Schema for an incident declared trigger.

\n
\n
\n
\n
\n
\n

incidentCreatedTrigger [required]

\n
\n

object

\n

Trigger a workflow when an incident is declared.

\n
\n
\n
\n
\n
\n

incidentType

\n
\n

string

\n

The type of incident that triggers the workflow.

\n
\n \n
\n
\n
\n
\n
\n

tagCondition

\n
\n

object

\n

Conditions that determine which incidents trigger the workflow.

\n
\n
\n
\n
\n
\n

tagValues

\n
\n

[object]

\n

Incident tags and values used to filter matching incidents.

\n
\n
\n
\n
\n
\n

tag [required]

\n
\n

string

\n

The incident tag to match.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The accepted values for the incident tag.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 12

\n
\n

object

\n

Schema for an incident impact created trigger.

\n
\n
\n
\n
\n
\n

incidentImpactCreatedTrigger [required]

\n
\n

object

\n

Trigger a workflow when an impact is created for an incident.

\n
\n
\n
\n
\n
\n

executionLimit

\n
\n

object

\n

The maximum number of times to execute a workflow for an incident.

\n
\n
\n
\n
\n
\n

count [required]

\n
\n

int32

\n

The maximum number of workflow executions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

incidentType

\n
\n

string

\n

The type of incident that triggers the workflow.

\n
\n \n
\n
\n
\n
\n
\n

tagCondition

\n
\n

object

\n

Conditions that determine which incidents trigger the workflow.

\n
\n
\n
\n
\n
\n

tagValues

\n
\n

[object]

\n

Incident tags and values used to filter matching incidents.

\n
\n
\n
\n
\n
\n

tag [required]

\n
\n

string

\n

The incident tag to match.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The accepted values for the incident tag.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 13

\n
\n

object

\n

Schema for an incident impact updated trigger.

\n
\n
\n
\n
\n
\n

incidentImpactUpdatedTrigger [required]

\n
\n

object

\n

Trigger a workflow when an impact is updated for an incident.

\n
\n
\n
\n
\n
\n

executionLimit

\n
\n

object

\n

The maximum number of times to execute a workflow for an incident.

\n
\n
\n
\n
\n
\n

count [required]

\n
\n

int32

\n

The maximum number of workflow executions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

incidentType

\n
\n

string

\n

The type of incident that triggers the workflow.

\n
\n \n
\n
\n
\n
\n
\n

tagCondition

\n
\n

object

\n

Conditions that determine which incidents trigger the workflow.

\n
\n
\n
\n
\n
\n

tagValues

\n
\n

[object]

\n

Incident tags and values used to filter matching incidents.

\n
\n
\n
\n
\n
\n

tag [required]

\n
\n

string

\n

The incident tag to match.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The accepted values for the incident tag.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 14

\n
\n

object

\n

Schema for an incident postmortem updated trigger.

\n
\n
\n
\n
\n
\n

incidentPostmortemUpdatedTrigger [required]

\n
\n

object

\n

Trigger a workflow when a postmortem is updated for an incident.

\n
\n
\n
\n
\n
\n

executionLimit

\n
\n

object

\n

The maximum number of times to execute a workflow for an incident.

\n
\n
\n
\n
\n
\n

count [required]

\n
\n

int32

\n

The maximum number of workflow executions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

incidentType

\n
\n

string

\n

The type of incident that triggers the workflow.

\n
\n \n
\n
\n
\n
\n
\n

tagCondition

\n
\n

object

\n

Conditions that determine which incidents trigger the workflow.

\n
\n
\n
\n
\n
\n

tagValues

\n
\n

[object]

\n

Incident tags and values used to filter matching incidents.

\n
\n
\n
\n
\n
\n

tag [required]

\n
\n

string

\n

The incident tag to match.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The accepted values for the incident tag.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 15

\n
\n

object

\n

Schema for an incident responder created trigger.

\n
\n
\n
\n
\n
\n

incidentResponderCreatedTrigger [required]

\n
\n

object

\n

Trigger a workflow when a responder is created for an incident.

\n
\n
\n
\n
\n
\n

executionLimit

\n
\n

object

\n

The maximum number of times to execute a workflow for an incident.

\n
\n
\n
\n
\n
\n

count [required]

\n
\n

int32

\n

The maximum number of workflow executions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

incidentType

\n
\n

string

\n

The type of incident that triggers the workflow.

\n
\n \n
\n
\n
\n
\n
\n

tagCondition

\n
\n

object

\n

Conditions that determine which incidents trigger the workflow.

\n
\n
\n
\n
\n
\n

tagValues

\n
\n

[object]

\n

Incident tags and values used to filter matching incidents.

\n
\n
\n
\n
\n
\n

tag [required]

\n
\n

string

\n

The incident tag to match.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The accepted values for the incident tag.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 16

\n
\n

object

\n

Schema for an incident declared or updated trigger.

\n
\n
\n
\n
\n
\n

incidentSavedTrigger [required]

\n
\n

object

\n

Trigger a workflow when an incident is declared or updated.

\n
\n
\n
\n
\n
\n

executionLimit

\n
\n

object

\n

The maximum number of times to execute a workflow for an incident.

\n
\n
\n
\n
\n
\n

count [required]

\n
\n

int32

\n

The maximum number of workflow executions.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

incidentType

\n
\n

string

\n

The type of incident that triggers the workflow.

\n
\n \n
\n
\n
\n
\n
\n

serialExecution

\n
\n

object

\n

Whether to execute the workflow serially for an incident.

\n
\n
\n
\n
\n
\n

enabled [required]

\n
\n

boolean

\n

Whether serial execution is enabled.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

tagCondition

\n
\n

object

\n

Conditions that determine which incidents trigger the workflow.

\n
\n
\n
\n
\n
\n

tagValues

\n
\n

[object]

\n

Incident tags and values used to filter matching incidents.

\n
\n
\n
\n
\n
\n

tag [required]

\n
\n

string

\n

The incident tag to match.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The accepted values for the incident tag.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 17

\n
\n

object

\n

Schema for an incident schedule trigger.

\n
\n
\n
\n
\n
\n

incidentScheduleTrigger [required]

\n
\n

object

\n

Trigger a workflow on a schedule for an incident.

\n
\n
\n
\n
\n
\n

incidentType

\n
\n

string

\n

The type of incident that triggers the workflow.

\n
\n \n
\n
\n
\n
\n
\n

rrule [required]

\n
\n

string

\n

The recurrence rule for the schedule, expressed as an iCalendar RRULE string.

\n
\n \n
\n
\n
\n
\n
\n

tagCondition

\n
\n

object

\n

Conditions that determine which incidents trigger the workflow.

\n
\n
\n
\n
\n
\n

tagValues

\n
\n

[object]

\n

Incident tags and values used to filter matching incidents.

\n
\n
\n
\n
\n
\n

tag [required]

\n
\n

string

\n

The incident tag to match.

\n
\n \n
\n
\n
\n
\n
\n

values [required]

\n
\n

[string]

\n

The accepted values for the incident tag.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 18

\n
\n

object

\n

Schema for an incident-based trigger.

\n
\n
\n
\n
\n
\n

incidentTrigger [required]

\n
\n

object

\n

Trigger a workflow from an incident. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

version

\n
\n

string

\n

Version of the incident manual trigger.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 19

\n
\n

object

\n

Schema for a Monitor-based trigger.

\n
\n
\n
\n
\n
\n

monitorTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Monitor. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 20

\n
\n

object

\n

Schema for a Notebook-based trigger.

\n
\n
\n
\n
\n
\n

notebookTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Notebook.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 21

\n
\n

object

\n

Schema for an On-Call-based trigger.

\n
\n
\n
\n
\n
\n

onCallTrigger [required]

\n
\n

object

\n

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.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 22

\n
\n

object

\n

Schema for a Schedule-based trigger.

\n
\n
\n
\n
\n
\n

scheduleTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Schedule. The workflow must be published.

\n
\n
\n
\n
\n
\n

overlapBehavior

\n
\n

enum

\n

Controls whether a scheduled workflow run may start while another instance is still running. \nAllowed enum values: EXCLUSIVE_RUN,OVERLAP_ALLOWED

default: EXCLUSIVE_RUN

\n
\n \n
\n
\n
\n
\n
\n

rruleExpression [required]

\n
\n

string

\n

Recurrence rule expression for scheduling.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 23

\n
\n

object

\n

Schema for a Security-based trigger.

\n
\n
\n
\n
\n
\n

securityTrigger [required]

\n
\n

object

\n

Trigger a workflow from a Security Signal or Finding. For automatic triggering a handle must be configured and the workflow must be published.

\n
\n
\n
\n
\n
\n

rateLimit

\n
\n

object

\n

Defines a rate limit for a trigger.

\n
\n
\n
\n
\n
\n

count

\n
\n

int64

\n

The TriggerRateLimit count.

\n
\n \n
\n
\n
\n
\n
\n

interval

\n
\n

string

\n

The TriggerRateLimit interval. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 24

\n
\n

object

\n

Schema for a Self Service-based trigger.

\n
\n
\n
\n
\n
\n

selfServiceTrigger [required]

\n
\n

object

\n

Trigger a workflow from Self Service.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 25

\n
\n

object

\n

Schema for a Slack-based trigger.

\n
\n
\n
\n
\n
\n

slackTrigger [required]

\n
\n

object

\n

Trigger a workflow from Slack. The workflow must be published.

\n
\n
\n
\n
\n
\n

reactionTriggers

\n
\n

[object]

\n

Slack emoji reactions that trigger the workflow.

\n
\n
\n
\n
\n
\n

reactionEmoji [required]

\n
\n

string

\n

The Slack emoji reaction name.

\n
\n \n
\n
\n
\n
\n
\n

teamId [required]

\n
\n

string

\n

The Slack workspace ID.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 26

\n
\n

object

\n

Schema for a Software Catalog-based trigger.

\n
\n
\n
\n
\n
\n

softwareCatalogTrigger [required]

\n
\n

object

\n

Trigger a workflow from Software Catalog.

\n
\n \n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

Object 27

\n
\n

object

\n

Schema for a Workflow-based trigger.

\n
\n
\n
\n
\n
\n

startStepNames

\n
\n

[string]

\n

Names of existing workflow steps that run first after a trigger fires.

\n
\n \n
\n
\n
\n
\n
\n

workflowTrigger [required]

\n
\n

object

\n

Trigger a workflow from the Datadog UI. When present, this must be the workflow's only trigger.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

Tags of the workflow.

\n
\n \n
\n
\n
\n
\n
\n

updatedAt

\n
\n

date-time

\n

When the workflow was last updated.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The workflow identifier

\n
\n \n
\n
\n
\n
\n
\n

relationships

\n
\n

object

\n

The definition of WorkflowDataRelationships object.

\n
\n
\n
\n
\n
\n

creator

\n
\n

object

\n

The definition of WorkflowUserRelationship object.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of WorkflowUserRelationshipData object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

owner

\n
\n

object

\n

The definition of WorkflowUserRelationship object.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of WorkflowUserRelationshipData object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

runAs

\n
\n

object

\n

The service account used to run the workflow. Present when runAsUserMode is service_account.

\n
\n
\n
\n
\n
\n

data

\n
\n

object

\n

The definition of WorkflowUserRelationshipData object.

\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The user identifier

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowUserRelationshipType object. \nAllowed enum values: users

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

The definition of WorkflowDataType object. \nAllowed enum values: workflows

\n
\n \n
\n
\n
\n
" }, "400": { "json": { diff --git a/hugo/data/api/v2/full_spec.yaml b/hugo/data/api/v2/full_spec.yaml index c9cb75ede2f..02ae1b7ff30 100644 --- a/hugo/data/api/v2/full_spec.yaml +++ b/hugo/data/api/v2/full_spec.yaml @@ -2114,6 +2114,15 @@ components: required: true schema: type: string + UnitCostID: + description: The UUID of the unit cost. + example: 64aecd58-e355-4f07-9c3a-56ff6bda6cd8 + in: path + name: unit_cost_id + required: true + schema: + format: uuid + type: string UserAuthorizedClientId: description: The ID of the user authorized client. in: path @@ -121739,6 +121748,236 @@ components: example: min type: string type: object + UnitCostCreateRequest: + description: A request to create a unit cost. + properties: + data: + $ref: "#/components/schemas/UnitCostCreateRequestData" + required: + - data + type: object + UnitCostCreateRequestData: + description: The data object of a unit cost create request. + properties: + attributes: + $ref: "#/components/schemas/UnitCostRequestAttributes" + type: + $ref: "#/components/schemas/UnitCostType" + required: + - type + - attributes + type: object + UnitCostDataAttributesResponse: + description: The attributes of a unit cost. + properties: + created_at: + description: The time the unit cost was created. + example: "2026-09-01T18:46:15.933716Z" + format: date-time + type: string + created_by: + description: The UUID of the user who created the unit cost. + example: 36ea1610-8866-4bd3-bb6d-9bb9fc87cad2 + format: uuid + type: string + denominator_query: + $ref: "#/components/schemas/UnitCostQueryDefinition" + denominator_type: + description: |- + The data source of the denominator queries, or `multisource` when the denominator + queries span more than one data source. + example: metrics + type: string + description: + description: The description of the unit cost. Omitted when the unit cost has no description. + example: Amortized cloud spend divided by the number of active users. + nullable: true + type: string + name: + description: The name of the unit cost. + example: Cloud cost per active user + type: string + numerator_query: + $ref: "#/components/schemas/UnitCostQueryDefinition" + org_id: + description: The ID of the organization the unit cost belongs to. + example: 321813 + format: int64 + type: integer + unit_label: + description: The label describing the denominator unit. + example: user + type: string + updated_at: + description: The time the unit cost was last updated. + example: "2026-09-01T19:52:08.820536Z" + format: date-time + type: string + updated_by: + description: The UUID of the user who last updated the unit cost. + example: 13cc0adf-2595-479e-b448-5051c180dddb + format: uuid + type: string + required: + - org_id + - name + - numerator_query + - denominator_query + - denominator_type + - unit_label + - created_by + - updated_by + - created_at + - updated_at + type: object + UnitCostDataResponse: + description: The data object of a unit cost response. + properties: + attributes: + $ref: "#/components/schemas/UnitCostDataAttributesResponse" + id: + description: The UUID of the unit cost. + example: 64aecd58-e355-4f07-9c3a-56ff6bda6cd8 + format: uuid + type: string + type: + $ref: "#/components/schemas/UnitCostType" + required: + - id + - type + - attributes + type: object + UnitCostDataResponseArray: + description: The list of unit costs. + items: + $ref: "#/components/schemas/UnitCostDataResponse" + type: array + UnitCostFormula: + additionalProperties: {} + description: |- + A formula combining the named queries into a single result, passed through to the + query engine unchanged. + example: + formula: numerator + type: object + UnitCostFormulaArray: + description: The list of formulas applied to the queries for this side of the ratio. + example: + - formula: numerator + items: + $ref: "#/components/schemas/UnitCostFormula" + type: array + UnitCostQuery: + additionalProperties: {} + description: |- + A single query contributing to a unit cost numerator or denominator. The accepted fields + depend on the data source the query targets, for example `cloud_cost`, `metrics`, `dora`, + or `ci_pipelines`, and are passed through to the query engine unchanged. + example: + data_source: cloud_cost + name: numerator + query: "sum:aws.cost.net.amortized.shared.resources.allocated{*}.rollup(sum, daily)" + type: object + UnitCostQueryArray: + description: The list of queries evaluated for this side of the ratio. + example: + - data_source: cloud_cost + name: numerator + query: "sum:aws.cost.net.amortized.shared.resources.allocated{*}.rollup(sum, daily)" + items: + $ref: "#/components/schemas/UnitCostQuery" + type: array + UnitCostQueryDefinition: + additionalProperties: {} + description: A timeseries object containing `queries` and `formulas` arrays. + properties: + formulas: + $ref: "#/components/schemas/UnitCostFormulaArray" + queries: + $ref: "#/components/schemas/UnitCostQueryArray" + required: + - queries + - formulas + type: object + UnitCostRequestAttributes: + description: The attributes of a unit cost create or replace request. + properties: + denominator_query: + $ref: "#/components/schemas/UnitCostQueryDefinition" + description: + description: An optional description of the unit cost. At most 2000 characters. + example: Amortized cloud spend divided by the number of active users. + maxLength: 2000 + nullable: true + type: string + name: + description: The name of the unit cost. At most 200 characters. + example: Cloud cost per active user + maxLength: 200 + type: string + numerator_query: + $ref: "#/components/schemas/UnitCostQueryDefinition" + unit_label: + description: The label describing the denominator unit, for example `user`. At most 100 characters. + example: user + maxLength: 100 + type: string + required: + - name + - numerator_query + - denominator_query + - unit_label + type: object + UnitCostResponse: + description: A response containing a single unit cost. + properties: + data: + $ref: "#/components/schemas/UnitCostDataResponse" + required: + - data + type: object + UnitCostType: + default: unit_cost + description: The JSON:API resource type for a unit cost. + enum: + - unit_cost + example: unit_cost + type: string + x-enum-varnames: + - UNIT_COST + UnitCostUpdateRequest: + description: A request to replace a unit cost. + properties: + data: + $ref: "#/components/schemas/UnitCostUpdateRequestData" + required: + - data + type: object + UnitCostUpdateRequestData: + description: The data object of a unit cost replace request. + properties: + attributes: + $ref: "#/components/schemas/UnitCostRequestAttributes" + id: + description: The UUID of the unit cost being replaced. Must match the `unit_cost_id` path parameter. + example: 64aecd58-e355-4f07-9c3a-56ff6bda6cd8 + format: uuid + type: string + type: + $ref: "#/components/schemas/UnitCostType" + required: + - id + - type + - attributes + type: object + UnitCostsResponse: + description: A response containing a list of unit costs. + properties: + data: + $ref: "#/components/schemas/UnitCostDataResponseArray" + required: + - data + type: object UnpublishAppResponse: description: The response object after an app is successfully unpublished. properties: @@ -144488,6 +144727,421 @@ paths: operator: OR permissions: - cloud_cost_management_read + /api/v2/cost/unit_costs: + get: + description: List the ROI metrics (unit costs) for the authenticated organization. + operationId: ListUnitCosts + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + - attributes: + created_at: "2026-09-01T18:46:15.933716Z" + created_by: 36ea1610-8866-4bd3-bb6d-9bb9fc87cad2 + denominator_query: + formulas: + - formula: denominator + queries: + - data_source: metrics + name: denominator + query: "avg:system.cpu.user{*}" + response_format: timeseries + denominator_type: metrics + name: Cloud cost per active user + numerator_query: + formulas: + - formula: numerator + queries: + - data_source: cloud_cost + name: numerator + query: "sum:aws.cost.net.amortized.shared.resources.allocated{*}.rollup(sum, daily)" + response_format: timeseries + org_id: 321813 + unit_label: user + updated_at: "2026-09-01T19:52:08.820536Z" + updated_by: 13cc0adf-2595-479e-b448-5051c180dddb + id: 64aecd58-e355-4f07-9c3a-56ff6bda6cd8 + type: unit_cost + - attributes: + created_at: "2026-09-02T00:59:12.708413Z" + created_by: 36ea1610-8866-4bd3-bb6d-9bb9fc87cad2 + denominator_query: + formulas: + - formula: denominator + queries: + - compute: + aggregation: count + data_source: ci_pipelines + group_by: [] + indexes: + - "*" + name: denominator + search: + query: "ci_level:pipeline @ci.status:success" + storage: hot + response_format: timeseries + denominator_type: ci_pipelines + name: Cloud cost per successful pipeline + numerator_query: + formulas: + - formula: numerator + queries: + - data_source: cloud_cost + name: numerator + query: "sum:custom.cost.amortized{*}.rollup(sum, daily)" + response_format: timeseries + org_id: 321813 + unit_label: pipeline + updated_at: "2026-09-02T01:00:05.709773Z" + updated_by: 36ea1610-8866-4bd3-bb6d-9bb9fc87cad2 + id: ab11677e-396e-4dce-8018-bbeb398315ae + type: unit_cost + schema: + $ref: "#/components/schemas/UnitCostsResponse" + description: OK + "403": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Forbidden + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + summary: List unit costs + tags: + - Cloud Cost Management + x-menu-order: 72 + "x-permission": + operator: OR + permissions: + - cloud_cost_management_read + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + post: + description: Create an ROI metric (unit cost) using the given numerator and denominator queries. + operationId: CreateUnitCost + requestBody: + content: + application/json: + examples: + default: + value: + data: + attributes: + denominator_query: + formulas: + - formula: denominator + queries: + - data_source: metrics + name: denominator + query: "avg:system.cpu.user{*}" + response_format: timeseries + name: Cloud cost per active user + numerator_query: + formulas: + - formula: numerator + queries: + - data_source: cloud_cost + name: numerator + query: "sum:aws.cost.net.amortized.shared.resources.allocated{*}.rollup(sum, daily)" + response_format: timeseries + unit_label: user + type: unit_cost + schema: + $ref: "#/components/schemas/UnitCostCreateRequest" + required: true + responses: + "201": + content: + application/json: + examples: + default: + value: + data: + attributes: + created_at: "2026-09-01T18:46:15.933716Z" + created_by: 36ea1610-8866-4bd3-bb6d-9bb9fc87cad2 + denominator_query: + formulas: + - formula: denominator + queries: + - data_source: metrics + name: denominator + query: "avg:system.cpu.user{*}" + response_format: timeseries + denominator_type: metrics + name: Cloud cost per active user + numerator_query: + formulas: + - formula: numerator + queries: + - data_source: cloud_cost + name: numerator + query: "sum:aws.cost.net.amortized.shared.resources.allocated{*}.rollup(sum, daily)" + response_format: timeseries + org_id: 321813 + unit_label: user + updated_at: "2026-09-01T18:46:15.933716Z" + updated_by: 36ea1610-8866-4bd3-bb6d-9bb9fc87cad2 + id: 64aecd58-e355-4f07-9c3a-56ff6bda6cd8 + type: unit_cost + schema: + $ref: "#/components/schemas/UnitCostResponse" + description: Created + headers: + Location: + description: The path of the newly created unit cost. + schema: + type: string + "400": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Bad Request + "403": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Forbidden + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + summary: Create a unit cost + tags: + - Cloud Cost Management + x-menu-order: 73 + "x-permission": + operator: OR + permissions: + - cloud_cost_management_read + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + /api/v2/cost/unit_costs/{unit_cost_id}: + delete: + description: Delete an ROI metric (unit cost). + operationId: DeleteUnitCost + parameters: + - $ref: "#/components/parameters/UnitCostID" + responses: + "204": + description: No Content + "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": + $ref: "#/components/responses/TooManyRequestsResponse" + summary: Delete a unit cost + tags: + - Cloud Cost Management + x-menu-order: 76 + "x-permission": + operator: OR + permissions: + - cloud_cost_management_read + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + get: + description: Retrieve an ROI metric (unit cost) by UUID. + operationId: GetUnitCost + parameters: + - $ref: "#/components/parameters/UnitCostID" + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + attributes: + created_at: "2026-09-01T18:46:15.933716Z" + created_by: 36ea1610-8866-4bd3-bb6d-9bb9fc87cad2 + denominator_query: + formulas: + - formula: denominator + queries: + - data_source: metrics + name: denominator + query: "avg:system.cpu.user{*}" + response_format: timeseries + denominator_type: metrics + name: Cloud cost per active user + numerator_query: + formulas: + - formula: numerator + queries: + - data_source: cloud_cost + name: numerator + query: "sum:aws.cost.net.amortized.shared.resources.allocated{*}.rollup(sum, daily)" + response_format: timeseries + org_id: 321813 + unit_label: user + updated_at: "2026-09-01T19:52:08.820536Z" + updated_by: 13cc0adf-2595-479e-b448-5051c180dddb + id: 64aecd58-e355-4f07-9c3a-56ff6bda6cd8 + type: unit_cost + schema: + $ref: "#/components/schemas/UnitCostResponse" + description: OK + "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": + $ref: "#/components/responses/TooManyRequestsResponse" + summary: Get a unit cost + tags: + - Cloud Cost Management + x-menu-order: 74 + "x-permission": + operator: OR + permissions: + - cloud_cost_management_read + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + put: + description: Replace an ROI metric (unit cost) with a new set of attributes. + operationId: UpdateUnitCost + parameters: + - $ref: "#/components/parameters/UnitCostID" + requestBody: + content: + application/json: + examples: + default: + value: + data: + attributes: + denominator_query: + formulas: + - formula: denominator + queries: + - data_source: metrics + name: denominator + query: "avg:system.cpu.user{*}" + response_format: timeseries + name: Cloud cost per active user + numerator_query: + formulas: + - formula: numerator + queries: + - data_source: cloud_cost + name: numerator + query: "sum:aws.cost.net.amortized.shared.resources.allocated{*}.rollup(sum, daily)" + response_format: timeseries + unit_label: user + id: 64aecd58-e355-4f07-9c3a-56ff6bda6cd8 + type: unit_cost + schema: + $ref: "#/components/schemas/UnitCostUpdateRequest" + required: true + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + attributes: + created_at: "2026-09-01T18:46:15.933716Z" + created_by: 36ea1610-8866-4bd3-bb6d-9bb9fc87cad2 + denominator_query: + formulas: + - formula: denominator + queries: + - data_source: metrics + name: denominator + query: "avg:system.cpu.user{*}" + response_format: timeseries + denominator_type: metrics + name: Cloud cost per active user + numerator_query: + formulas: + - formula: numerator + queries: + - data_source: cloud_cost + name: numerator + query: "sum:aws.cost.net.amortized.shared.resources.allocated{*}.rollup(sum, daily)" + response_format: timeseries + org_id: 321813 + unit_label: user + updated_at: "2026-09-01T19:52:08.820536Z" + updated_by: 13cc0adf-2595-479e-b448-5051c180dddb + id: 64aecd58-e355-4f07-9c3a-56ff6bda6cd8 + type: unit_cost + schema: + $ref: "#/components/schemas/UnitCostResponse" + description: OK + "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": + $ref: "#/components/responses/TooManyRequestsResponse" + summary: Update a unit cost + tags: + - Cloud Cost Management + x-menu-order: 75 + "x-permission": + operator: OR + permissions: + - cloud_cost_management_read + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/cost_by_tag/active_billing_dimensions: get: description: |- diff --git a/hugo/data/api/v2/translate_actions.json b/hugo/data/api/v2/translate_actions.json index 31d9256eb4d..7f911360d91 100644 --- a/hugo/data/api/v2/translate_actions.json +++ b/hugo/data/api/v2/translate_actions.json @@ -1416,6 +1416,30 @@ "description": "List Cloud Cost Management tags for a given metric.", "summary": "List Cloud Cost Management tags" }, + "ListUnitCosts": { + "description": "List the ROI metrics (unit costs) for the authenticated organization.", + "summary": "List unit costs" + }, + "CreateUnitCost": { + "description": "Create an ROI metric (unit cost) using the given numerator and denominator queries.", + "summary": "Create a unit cost", + "request_description": "", + "request_schema_description": "A request to create a unit cost." + }, + "DeleteUnitCost": { + "description": "Delete an ROI metric (unit cost).", + "summary": "Delete a unit cost" + }, + "GetUnitCost": { + "description": "Retrieve an ROI metric (unit cost) by UUID.", + "summary": "Get a unit cost" + }, + "UpdateUnitCost": { + "description": "Replace an ROI metric (unit cost) with a new set of attributes.", + "summary": "Update a unit cost", + "request_description": "", + "request_schema_description": "A request to replace a unit cost." + }, "GetActiveBillingDimensions": { "description": "Get active billing dimensions for cost attribution. Cost data for a given month becomes available no later than the 19th of the following month.", "summary": "Get active billing dimensions for cost attribution"