data [required]
\n[object]
List of AWS Account Integration Configs.
attributes
\nobject
AWS Account response attributes.
account_tags
\n[string]
Tags to apply to all hosts and metrics reporting for this account. Defaults to [].
auth_config
\n<oneOf>
AWS Authentication config.
Option 1
\nobject
AWS Authentication config to integrate your account using an access key pair.
access_key_id [required]
\nstring
AWS Access Key ID.
secret_access_key
\nstring
AWS Secret Access Key.
Option 2
\nobject
AWS Authentication config to integrate your account using an IAM role.
external_id
\nstring
AWS IAM External ID for associated role.
role_name [required]
\nstring
AWS IAM Role name.
aws_account_id [required]
\nstring
AWS Account ID.
aws_partition
\nenum
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
aws_regions
\n<oneOf>
AWS Regions to collect data from. Defaults to include_all.
Option 1
\nobject
Include all regions. Defaults to true.
include_all [required]
\nboolean
Include all regions.
Option 2
\nobject
Include only these regions.
include_only [required]
\n[string]
Include only these regions.
created_at
\ndate-time
Timestamp of when the account integration was created.
logs_config
\nobject
AWS Logs Collection config.
lambda_forwarder
\nobject
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.
lambdas
\n[string]
List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to [].
log_source_config
\nobject
Log source configuration.
tag_filters
\n[object]
List of AWS log source tag filters. Defaults to [].
source
\nstring
The AWS log source to which the tag filters defined in tags are applied.
tags
\n[string]
The AWS resource tags to filter on for the log source specified by source.
sources
\n[string]
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.
metrics_config
\nobject
AWS Metrics Collection config.
automute_enabled
\nboolean
Enable EC2 automute for AWS metrics. Defaults to true.
collect_cloudwatch_alarms
\nboolean
Enable CloudWatch alarms collection. Defaults to false.
collect_custom_metrics
\nboolean
Enable custom metrics collection. Defaults to false.
enabled
\nboolean
Enable AWS metrics collection. Defaults to true.
namespace_filters
\n<oneOf>
AWS Metrics namespace filters. Defaults to exclude_only.
Option 1
\nobject
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.
exclude_only [required]
\n[string]
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.
Option 2
\nobject
Include only these namespaces.
include_only [required]
\n[string]
Include only these namespaces.
tag_filters
\n[object]
AWS Metrics collection tag filters list. Defaults to [].
namespace
\nstring
The AWS service for which the tag filters defined in tags will be applied.
tags
\n[string]
The AWS resource tags to filter on for the service specified by namespace.
modified_at
\ndate-time
Timestamp of when the account integration was updated.
resources_config
\nobject
AWS Resources Collection config.
cloud_security_posture_management_collection
\nboolean
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.
extended_collection
\nboolean
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.
traces_config
\nobject
AWS Traces Collection config.
xray_services
\n<oneOf>
AWS X-Ray services to collect traces from. Defaults to include_only.
Option 1
\nobject
Include all services.
include_all [required]
\nboolean
Include all services.
Option 2
\nobject
Include only these services. Defaults to [].
include_only [required]
\n[string]
Include only these services.
id [required]
\nstring
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.
type [required]
\nenum
AWS Account resource type. \nAllowed enum values: account
default: account
data [required]
\n[object]
List of AWS Account Integration Configs.
attributes
\nobject
AWS Account response attributes.
account_tags
\n[string]
Tags to apply to all hosts and metrics reporting for this account. Defaults to [].
auth_config
\n<oneOf>
AWS Authentication config.
Option 1
\nobject
AWS Authentication config to integrate your account using an access key pair.
access_key_id [required]
\nstring
AWS Access Key ID.
secret_access_key
\nstring
AWS Secret Access Key.
Option 2
\nobject
AWS Authentication config to integrate your account using an IAM role.
external_id
\nstring
AWS IAM External ID for associated role.
role_name [required]
\nstring
AWS IAM Role name.
aws_account_id [required]
\nstring
AWS Account ID.
aws_partition
\nenum
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
aws_regions
\n<oneOf>
AWS Regions to collect data from. Defaults to include_all.
Option 1
\nobject
Include all regions. Defaults to true.
include_all [required]
\nboolean
Include all regions.
Option 2
\nobject
Include only these regions.
include_only [required]
\n[string]
Include only these regions.
created_at
\ndate-time
Timestamp of when the account integration was created.
logs_config
\nobject
AWS Logs Collection config.
lambda_forwarder
\nobject
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.
lambdas
\n[string]
List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to [].
log_source_config
\nobject
Log source configuration.
tag_filters
\n[object]
List of AWS log source tag filters. Defaults to [].
source
\nstring
The AWS log source to which the tag filters defined in tags are applied.
tags
\n[string]
The AWS resource tags to filter on for the log source specified by source.
sources
\n[string]
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.
metrics_config
\nobject
AWS Metrics Collection config.
automute_enabled
\nboolean
Enable EC2 automute for AWS metrics. Defaults to true.
collect_cloudwatch_alarms
\nboolean
Enable CloudWatch alarms collection. Defaults to false.
collect_custom_metrics
\nboolean
Enable custom metrics collection. Defaults to false.
enabled
\nboolean
Enable AWS metrics collection. Defaults to true.
metric_name_filters
\n[ <oneOf>]
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.
Option 1
\nobject
Include only metric names matching one of these patterns for a single namespace.
include_only [required]
\n[string]
Include only metric names matching one of these patterns.
namespace [required]
\nstring
The AWS CloudWatch namespace to which this metric name filter applies.
Option 2
\nobject
Exclude metric names matching one of these patterns for a single namespace.
exclude_only [required]
\n[string]
Exclude metric names matching one of these patterns.
namespace [required]
\nstring
The AWS CloudWatch namespace to which this metric name filter applies.
namespace_filters
\n<oneOf>
AWS Metrics namespace filters. Defaults to exclude_only.
Option 1
\nobject
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.
exclude_only [required]
\n[string]
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.
Option 2
\nobject
Include only these namespaces.
include_only [required]
\n[string]
Include only these namespaces.
tag_filters
\n[object]
AWS Metrics collection tag filters list. Defaults to [].
namespace
\nstring
The AWS service for which the tag filters defined in tags will be applied.
tags
\n[string]
The AWS resource tags to filter on for the service specified by namespace.
modified_at
\ndate-time
Timestamp of when the account integration was updated.
resources_config
\nobject
AWS Resources Collection config.
cloud_security_posture_management_collection
\nboolean
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.
extended_collection
\nboolean
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.
traces_config
\nobject
AWS Traces Collection config.
xray_services
\n<oneOf>
AWS X-Ray services to collect traces from. Defaults to include_only.
Option 1
\nobject
Include all services.
include_all [required]
\nboolean
Include all services.
Option 2
\nobject
Include only these services. Defaults to [].
include_only [required]
\n[string]
Include only these services.
id [required]
\nstring
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.
type [required]
\nenum
AWS Account resource type. \nAllowed enum values: account
default: account
data [required]
\nobject
AWS Account response data.
attributes
\nobject
AWS Account response attributes.
account_tags
\n[string]
Tags to apply to all hosts and metrics reporting for this account. Defaults to [].
auth_config
\n<oneOf>
AWS Authentication config.
Option 1
\nobject
AWS Authentication config to integrate your account using an access key pair.
access_key_id [required]
\nstring
AWS Access Key ID.
secret_access_key
\nstring
AWS Secret Access Key.
Option 2
\nobject
AWS Authentication config to integrate your account using an IAM role.
external_id
\nstring
AWS IAM External ID for associated role.
role_name [required]
\nstring
AWS IAM Role name.
aws_account_id [required]
\nstring
AWS Account ID.
aws_partition
\nenum
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
aws_regions
\n<oneOf>
AWS Regions to collect data from. Defaults to include_all.
Option 1
\nobject
Include all regions. Defaults to true.
include_all [required]
\nboolean
Include all regions.
Option 2
\nobject
Include only these regions.
include_only [required]
\n[string]
Include only these regions.
created_at
\ndate-time
Timestamp of when the account integration was created.
logs_config
\nobject
AWS Logs Collection config.
lambda_forwarder
\nobject
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.
lambdas
\n[string]
List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to [].
log_source_config
\nobject
Log source configuration.
tag_filters
\n[object]
List of AWS log source tag filters. Defaults to [].
source
\nstring
The AWS log source to which the tag filters defined in tags are applied.
tags
\n[string]
The AWS resource tags to filter on for the log source specified by source.
sources
\n[string]
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.
metrics_config
\nobject
AWS Metrics Collection config.
automute_enabled
\nboolean
Enable EC2 automute for AWS metrics. Defaults to true.
collect_cloudwatch_alarms
\nboolean
Enable CloudWatch alarms collection. Defaults to false.
collect_custom_metrics
\nboolean
Enable custom metrics collection. Defaults to false.
enabled
\nboolean
Enable AWS metrics collection. Defaults to true.
namespace_filters
\n<oneOf>
AWS Metrics namespace filters. Defaults to exclude_only.
Option 1
\nobject
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.
exclude_only [required]
\n[string]
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.
Option 2
\nobject
Include only these namespaces.
include_only [required]
\n[string]
Include only these namespaces.
tag_filters
\n[object]
AWS Metrics collection tag filters list. Defaults to [].
namespace
\nstring
The AWS service for which the tag filters defined in tags will be applied.
tags
\n[string]
The AWS resource tags to filter on for the service specified by namespace.
modified_at
\ndate-time
Timestamp of when the account integration was updated.
resources_config
\nobject
AWS Resources Collection config.
cloud_security_posture_management_collection
\nboolean
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.
extended_collection
\nboolean
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.
traces_config
\nobject
AWS Traces Collection config.
xray_services
\n<oneOf>
AWS X-Ray services to collect traces from. Defaults to include_only.
Option 1
\nobject
Include all services.
include_all [required]
\nboolean
Include all services.
Option 2
\nobject
Include only these services. Defaults to [].
include_only [required]
\n[string]
Include only these services.
id [required]
\nstring
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.
type [required]
\nenum
AWS Account resource type. \nAllowed enum values: account
default: account
data [required]
\nobject
AWS Account response data.
attributes
\nobject
AWS Account response attributes.
account_tags
\n[string]
Tags to apply to all hosts and metrics reporting for this account. Defaults to [].
auth_config
\n<oneOf>
AWS Authentication config.
Option 1
\nobject
AWS Authentication config to integrate your account using an access key pair.
access_key_id [required]
\nstring
AWS Access Key ID.
secret_access_key
\nstring
AWS Secret Access Key.
Option 2
\nobject
AWS Authentication config to integrate your account using an IAM role.
external_id
\nstring
AWS IAM External ID for associated role.
role_name [required]
\nstring
AWS IAM Role name.
aws_account_id [required]
\nstring
AWS Account ID.
aws_partition
\nenum
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
aws_regions
\n<oneOf>
AWS Regions to collect data from. Defaults to include_all.
Option 1
\nobject
Include all regions. Defaults to true.
include_all [required]
\nboolean
Include all regions.
Option 2
\nobject
Include only these regions.
include_only [required]
\n[string]
Include only these regions.
created_at
\ndate-time
Timestamp of when the account integration was created.
logs_config
\nobject
AWS Logs Collection config.
lambda_forwarder
\nobject
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.
lambdas
\n[string]
List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to [].
log_source_config
\nobject
Log source configuration.
tag_filters
\n[object]
List of AWS log source tag filters. Defaults to [].
source
\nstring
The AWS log source to which the tag filters defined in tags are applied.
tags
\n[string]
The AWS resource tags to filter on for the log source specified by source.
sources
\n[string]
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.
metrics_config
\nobject
AWS Metrics Collection config.
automute_enabled
\nboolean
Enable EC2 automute for AWS metrics. Defaults to true.
collect_cloudwatch_alarms
\nboolean
Enable CloudWatch alarms collection. Defaults to false.
collect_custom_metrics
\nboolean
Enable custom metrics collection. Defaults to false.
enabled
\nboolean
Enable AWS metrics collection. Defaults to true.
metric_name_filters
\n[ <oneOf>]
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.
Option 1
\nobject
Include only metric names matching one of these patterns for a single namespace.
include_only [required]
\n[string]
Include only metric names matching one of these patterns.
namespace [required]
\nstring
The AWS CloudWatch namespace to which this metric name filter applies.
Option 2
\nobject
Exclude metric names matching one of these patterns for a single namespace.
exclude_only [required]
\n[string]
Exclude metric names matching one of these patterns.
namespace [required]
\nstring
The AWS CloudWatch namespace to which this metric name filter applies.
namespace_filters
\n<oneOf>
AWS Metrics namespace filters. Defaults to exclude_only.
Option 1
\nobject
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.
exclude_only [required]
\n[string]
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.
Option 2
\nobject
Include only these namespaces.
include_only [required]
\n[string]
Include only these namespaces.
tag_filters
\n[object]
AWS Metrics collection tag filters list. Defaults to [].
namespace
\nstring
The AWS service for which the tag filters defined in tags will be applied.
tags
\n[string]
The AWS resource tags to filter on for the service specified by namespace.
modified_at
\ndate-time
Timestamp of when the account integration was updated.
resources_config
\nobject
AWS Resources Collection config.
cloud_security_posture_management_collection
\nboolean
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.
extended_collection
\nboolean
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.
traces_config
\nobject
AWS Traces Collection config.
xray_services
\n<oneOf>
AWS X-Ray services to collect traces from. Defaults to include_only.
Option 1
\nobject
Include all services.
include_all [required]
\nboolean
Include all services.
Option 2
\nobject
Include only these services. Defaults to [].
include_only [required]
\n[string]
Include only these services.
id [required]
\nstring
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.
type [required]
\nenum
AWS Account resource type. \nAllowed enum values: account
default: account
data [required]
\nobject
AWS Account Create Request data.
attributes [required]
\nobject
The AWS Account Integration Config to be created.
account_tags
\n[string]
Tags to apply to all hosts and metrics reporting for this account. Defaults to [].
auth_config [required]
\n<oneOf>
AWS Authentication config.
Option 1
\nobject
AWS Authentication config to integrate your account using an access key pair.
access_key_id [required]
\nstring
AWS Access Key ID.
secret_access_key
\nstring
AWS Secret Access Key.
Option 2
\nobject
AWS Authentication config to integrate your account using an IAM role.
external_id
\nstring
AWS IAM External ID for associated role.
role_name [required]
\nstring
AWS IAM Role name.
aws_account_id [required]
\nstring
AWS Account ID.
aws_partition [required]
\nenum
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
aws_regions
\n<oneOf>
AWS Regions to collect data from. Defaults to include_all.
Option 1
\nobject
Include all regions. Defaults to true.
include_all [required]
\nboolean
Include all regions.
Option 2
\nobject
Include only these regions.
include_only [required]
\n[string]
Include only these regions.
logs_config
\nobject
AWS Logs Collection config.
lambda_forwarder
\nobject
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.
lambdas
\n[string]
List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to [].
log_source_config
\nobject
Log source configuration.
tag_filters
\n[object]
List of AWS log source tag filters. Defaults to [].
source
\nstring
The AWS log source to which the tag filters defined in tags are applied.
tags
\n[string]
The AWS resource tags to filter on for the log source specified by source.
sources
\n[string]
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.
metrics_config
\nobject
AWS Metrics Collection config.
automute_enabled
\nboolean
Enable EC2 automute for AWS metrics. Defaults to true.
collect_cloudwatch_alarms
\nboolean
Enable CloudWatch alarms collection. Defaults to false.
collect_custom_metrics
\nboolean
Enable custom metrics collection. Defaults to false.
enabled
\nboolean
Enable AWS metrics collection. Defaults to true.
namespace_filters
\n<oneOf>
AWS Metrics namespace filters. Defaults to exclude_only.
Option 1
\nobject
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.
exclude_only [required]
\n[string]
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.
Option 2
\nobject
Include only these namespaces.
include_only [required]
\n[string]
Include only these namespaces.
tag_filters
\n[object]
AWS Metrics collection tag filters list. Defaults to [].
namespace
\nstring
The AWS service for which the tag filters defined in tags will be applied.
tags
\n[string]
The AWS resource tags to filter on for the service specified by namespace.
resources_config
\nobject
AWS Resources Collection config.
cloud_security_posture_management_collection
\nboolean
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.
extended_collection
\nboolean
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.
traces_config
\nobject
AWS Traces Collection config.
xray_services
\n<oneOf>
AWS X-Ray services to collect traces from. Defaults to include_only.
Option 1
\nobject
Include all services.
include_all [required]
\nboolean
Include all services.
Option 2
\nobject
Include only these services. Defaults to [].
include_only [required]
\n[string]
Include only these services.
type [required]
\nenum
AWS Account resource type. \nAllowed enum values: account
default: account
data [required]
\nobject
AWS Account Create Request data.
attributes [required]
\nobject
The AWS Account Integration Config to be created.
account_tags
\n[string]
Tags to apply to all hosts and metrics reporting for this account. Defaults to [].
auth_config [required]
\n<oneOf>
AWS Authentication config.
Option 1
\nobject
AWS Authentication config to integrate your account using an access key pair.
access_key_id [required]
\nstring
AWS Access Key ID.
secret_access_key
\nstring
AWS Secret Access Key.
Option 2
\nobject
AWS Authentication config to integrate your account using an IAM role.
external_id
\nstring
AWS IAM External ID for associated role.
role_name [required]
\nstring
AWS IAM Role name.
aws_account_id [required]
\nstring
AWS Account ID.
aws_partition [required]
\nenum
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
aws_regions
\n<oneOf>
AWS Regions to collect data from. Defaults to include_all.
Option 1
\nobject
Include all regions. Defaults to true.
include_all [required]
\nboolean
Include all regions.
Option 2
\nobject
Include only these regions.
include_only [required]
\n[string]
Include only these regions.
logs_config
\nobject
AWS Logs Collection config.
lambda_forwarder
\nobject
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.
lambdas
\n[string]
List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to [].
log_source_config
\nobject
Log source configuration.
tag_filters
\n[object]
List of AWS log source tag filters. Defaults to [].
source
\nstring
The AWS log source to which the tag filters defined in tags are applied.
tags
\n[string]
The AWS resource tags to filter on for the log source specified by source.
sources
\n[string]
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.
metrics_config
\nobject
AWS Metrics Collection config.
automute_enabled
\nboolean
Enable EC2 automute for AWS metrics. Defaults to true.
collect_cloudwatch_alarms
\nboolean
Enable CloudWatch alarms collection. Defaults to false.
collect_custom_metrics
\nboolean
Enable custom metrics collection. Defaults to false.
enabled
\nboolean
Enable AWS metrics collection. Defaults to true.
metric_name_filters
\n[ <oneOf>]
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.
Option 1
\nobject
Include only metric names matching one of these patterns for a single namespace.
include_only [required]
\n[string]
Include only metric names matching one of these patterns.
namespace [required]
\nstring
The AWS CloudWatch namespace to which this metric name filter applies.
Option 2
\nobject
Exclude metric names matching one of these patterns for a single namespace.
exclude_only [required]
\n[string]
Exclude metric names matching one of these patterns.
namespace [required]
\nstring
The AWS CloudWatch namespace to which this metric name filter applies.
namespace_filters
\n<oneOf>
AWS Metrics namespace filters. Defaults to exclude_only.
Option 1
\nobject
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.
exclude_only [required]
\n[string]
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.
Option 2
\nobject
Include only these namespaces.
include_only [required]
\n[string]
Include only these namespaces.
tag_filters
\n[object]
AWS Metrics collection tag filters list. Defaults to [].
namespace
\nstring
The AWS service for which the tag filters defined in tags will be applied.
tags
\n[string]
The AWS resource tags to filter on for the service specified by namespace.
resources_config
\nobject
AWS Resources Collection config.
cloud_security_posture_management_collection
\nboolean
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.
extended_collection
\nboolean
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.
traces_config
\nobject
AWS Traces Collection config.
xray_services
\n<oneOf>
AWS X-Ray services to collect traces from. Defaults to include_only.
Option 1
\nobject
Include all services.
include_all [required]
\nboolean
Include all services.
Option 2
\nobject
Include only these services. Defaults to [].
include_only [required]
\n[string]
Include only these services.
type [required]
\nenum
AWS Account resource type. \nAllowed enum values: account
default: account
data [required]
\nobject
AWS Account response data.
attributes
\nobject
AWS Account response attributes.
account_tags
\n[string]
Tags to apply to all hosts and metrics reporting for this account. Defaults to [].
auth_config
\n<oneOf>
AWS Authentication config.
Option 1
\nobject
AWS Authentication config to integrate your account using an access key pair.
access_key_id [required]
\nstring
AWS Access Key ID.
secret_access_key
\nstring
AWS Secret Access Key.
Option 2
\nobject
AWS Authentication config to integrate your account using an IAM role.
external_id
\nstring
AWS IAM External ID for associated role.
role_name [required]
\nstring
AWS IAM Role name.
aws_account_id [required]
\nstring
AWS Account ID.
aws_partition
\nenum
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
aws_regions
\n<oneOf>
AWS Regions to collect data from. Defaults to include_all.
Option 1
\nobject
Include all regions. Defaults to true.
include_all [required]
\nboolean
Include all regions.
Option 2
\nobject
Include only these regions.
include_only [required]
\n[string]
Include only these regions.
created_at
\ndate-time
Timestamp of when the account integration was created.
logs_config
\nobject
AWS Logs Collection config.
lambda_forwarder
\nobject
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.
lambdas
\n[string]
List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to [].
log_source_config
\nobject
Log source configuration.
tag_filters
\n[object]
List of AWS log source tag filters. Defaults to [].
source
\nstring
The AWS log source to which the tag filters defined in tags are applied.
tags
\n[string]
The AWS resource tags to filter on for the log source specified by source.
sources
\n[string]
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.
metrics_config
\nobject
AWS Metrics Collection config.
automute_enabled
\nboolean
Enable EC2 automute for AWS metrics. Defaults to true.
collect_cloudwatch_alarms
\nboolean
Enable CloudWatch alarms collection. Defaults to false.
collect_custom_metrics
\nboolean
Enable custom metrics collection. Defaults to false.
enabled
\nboolean
Enable AWS metrics collection. Defaults to true.
namespace_filters
\n<oneOf>
AWS Metrics namespace filters. Defaults to exclude_only.
Option 1
\nobject
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.
exclude_only [required]
\n[string]
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.
Option 2
\nobject
Include only these namespaces.
include_only [required]
\n[string]
Include only these namespaces.
tag_filters
\n[object]
AWS Metrics collection tag filters list. Defaults to [].
namespace
\nstring
The AWS service for which the tag filters defined in tags will be applied.
tags
\n[string]
The AWS resource tags to filter on for the service specified by namespace.
modified_at
\ndate-time
Timestamp of when the account integration was updated.
resources_config
\nobject
AWS Resources Collection config.
cloud_security_posture_management_collection
\nboolean
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.
extended_collection
\nboolean
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.
traces_config
\nobject
AWS Traces Collection config.
xray_services
\n<oneOf>
AWS X-Ray services to collect traces from. Defaults to include_only.
Option 1
\nobject
Include all services.
include_all [required]
\nboolean
Include all services.
Option 2
\nobject
Include only these services. Defaults to [].
include_only [required]
\n[string]
Include only these services.
id [required]
\nstring
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.
type [required]
\nenum
AWS Account resource type. \nAllowed enum values: account
default: account
data [required]
\nobject
AWS Account response data.
attributes
\nobject
AWS Account response attributes.
account_tags
\n[string]
Tags to apply to all hosts and metrics reporting for this account. Defaults to [].
auth_config
\n<oneOf>
AWS Authentication config.
Option 1
\nobject
AWS Authentication config to integrate your account using an access key pair.
access_key_id [required]
\nstring
AWS Access Key ID.
secret_access_key
\nstring
AWS Secret Access Key.
Option 2
\nobject
AWS Authentication config to integrate your account using an IAM role.
external_id
\nstring
AWS IAM External ID for associated role.
role_name [required]
\nstring
AWS IAM Role name.
aws_account_id [required]
\nstring
AWS Account ID.
aws_partition
\nenum
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
aws_regions
\n<oneOf>
AWS Regions to collect data from. Defaults to include_all.
Option 1
\nobject
Include all regions. Defaults to true.
include_all [required]
\nboolean
Include all regions.
Option 2
\nobject
Include only these regions.
include_only [required]
\n[string]
Include only these regions.
created_at
\ndate-time
Timestamp of when the account integration was created.
logs_config
\nobject
AWS Logs Collection config.
lambda_forwarder
\nobject
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.
lambdas
\n[string]
List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to [].
log_source_config
\nobject
Log source configuration.
tag_filters
\n[object]
List of AWS log source tag filters. Defaults to [].
source
\nstring
The AWS log source to which the tag filters defined in tags are applied.
tags
\n[string]
The AWS resource tags to filter on for the log source specified by source.
sources
\n[string]
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.
metrics_config
\nobject
AWS Metrics Collection config.
automute_enabled
\nboolean
Enable EC2 automute for AWS metrics. Defaults to true.
collect_cloudwatch_alarms
\nboolean
Enable CloudWatch alarms collection. Defaults to false.
collect_custom_metrics
\nboolean
Enable custom metrics collection. Defaults to false.
enabled
\nboolean
Enable AWS metrics collection. Defaults to true.
metric_name_filters
\n[ <oneOf>]
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.
Option 1
\nobject
Include only metric names matching one of these patterns for a single namespace.
include_only [required]
\n[string]
Include only metric names matching one of these patterns.
namespace [required]
\nstring
The AWS CloudWatch namespace to which this metric name filter applies.
Option 2
\nobject
Exclude metric names matching one of these patterns for a single namespace.
exclude_only [required]
\n[string]
Exclude metric names matching one of these patterns.
namespace [required]
\nstring
The AWS CloudWatch namespace to which this metric name filter applies.
namespace_filters
\n<oneOf>
AWS Metrics namespace filters. Defaults to exclude_only.
Option 1
\nobject
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.
exclude_only [required]
\n[string]
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.
Option 2
\nobject
Include only these namespaces.
include_only [required]
\n[string]
Include only these namespaces.
tag_filters
\n[object]
AWS Metrics collection tag filters list. Defaults to [].
namespace
\nstring
The AWS service for which the tag filters defined in tags will be applied.
tags
\n[string]
The AWS resource tags to filter on for the service specified by namespace.
modified_at
\ndate-time
Timestamp of when the account integration was updated.
resources_config
\nobject
AWS Resources Collection config.
cloud_security_posture_management_collection
\nboolean
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.
extended_collection
\nboolean
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.
traces_config
\nobject
AWS Traces Collection config.
xray_services
\n<oneOf>
AWS X-Ray services to collect traces from. Defaults to include_only.
Option 1
\nobject
Include all services.
include_all [required]
\nboolean
Include all services.
Option 2
\nobject
Include only these services. Defaults to [].
include_only [required]
\n[string]
Include only these services.
id [required]
\nstring
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.
type [required]
\nenum
AWS Account resource type. \nAllowed enum values: account
default: account
data [required]
\nobject
AWS Account response data.
attributes
\nobject
AWS Account response attributes.
account_tags
\n[string]
Tags to apply to all hosts and metrics reporting for this account. Defaults to [].
auth_config
\n<oneOf>
AWS Authentication config.
Option 1
\nobject
AWS Authentication config to integrate your account using an access key pair.
access_key_id [required]
\nstring
AWS Access Key ID.
secret_access_key
\nstring
AWS Secret Access Key.
Option 2
\nobject
AWS Authentication config to integrate your account using an IAM role.
external_id
\nstring
AWS IAM External ID for associated role.
role_name [required]
\nstring
AWS IAM Role name.
aws_account_id [required]
\nstring
AWS Account ID.
aws_partition
\nenum
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
aws_regions
\n<oneOf>
AWS Regions to collect data from. Defaults to include_all.
Option 1
\nobject
Include all regions. Defaults to true.
include_all [required]
\nboolean
Include all regions.
Option 2
\nobject
Include only these regions.
include_only [required]
\n[string]
Include only these regions.
created_at
\ndate-time
Timestamp of when the account integration was created.
logs_config
\nobject
AWS Logs Collection config.
lambda_forwarder
\nobject
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.
lambdas
\n[string]
List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to [].
log_source_config
\nobject
Log source configuration.
tag_filters
\n[object]
List of AWS log source tag filters. Defaults to [].
source
\nstring
The AWS log source to which the tag filters defined in tags are applied.
tags
\n[string]
The AWS resource tags to filter on for the log source specified by source.
sources
\n[string]
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.
metrics_config
\nobject
AWS Metrics Collection config.
automute_enabled
\nboolean
Enable EC2 automute for AWS metrics. Defaults to true.
collect_cloudwatch_alarms
\nboolean
Enable CloudWatch alarms collection. Defaults to false.
collect_custom_metrics
\nboolean
Enable custom metrics collection. Defaults to false.
enabled
\nboolean
Enable AWS metrics collection. Defaults to true.
namespace_filters
\n<oneOf>
AWS Metrics namespace filters. Defaults to exclude_only.
Option 1
\nobject
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.
exclude_only [required]
\n[string]
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.
Option 2
\nobject
Include only these namespaces.
include_only [required]
\n[string]
Include only these namespaces.
tag_filters
\n[object]
AWS Metrics collection tag filters list. Defaults to [].
namespace
\nstring
The AWS service for which the tag filters defined in tags will be applied.
tags
\n[string]
The AWS resource tags to filter on for the service specified by namespace.
modified_at
\ndate-time
Timestamp of when the account integration was updated.
resources_config
\nobject
AWS Resources Collection config.
cloud_security_posture_management_collection
\nboolean
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.
extended_collection
\nboolean
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.
traces_config
\nobject
AWS Traces Collection config.
xray_services
\n<oneOf>
AWS X-Ray services to collect traces from. Defaults to include_only.
Option 1
\nobject
Include all services.
include_all [required]
\nboolean
Include all services.
Option 2
\nobject
Include only these services. Defaults to [].
include_only [required]
\n[string]
Include only these services.
id [required]
\nstring
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.
type [required]
\nenum
AWS Account resource type. \nAllowed enum values: account
default: account
data [required]
\nobject
AWS Account response data.
attributes
\nobject
AWS Account response attributes.
account_tags
\n[string]
Tags to apply to all hosts and metrics reporting for this account. Defaults to [].
auth_config
\n<oneOf>
AWS Authentication config.
Option 1
\nobject
AWS Authentication config to integrate your account using an access key pair.
access_key_id [required]
\nstring
AWS Access Key ID.
secret_access_key
\nstring
AWS Secret Access Key.
Option 2
\nobject
AWS Authentication config to integrate your account using an IAM role.
external_id
\nstring
AWS IAM External ID for associated role.
role_name [required]
\nstring
AWS IAM Role name.
aws_account_id [required]
\nstring
AWS Account ID.
aws_partition
\nenum
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
aws_regions
\n<oneOf>
AWS Regions to collect data from. Defaults to include_all.
Option 1
\nobject
Include all regions. Defaults to true.
include_all [required]
\nboolean
Include all regions.
Option 2
\nobject
Include only these regions.
include_only [required]
\n[string]
Include only these regions.
created_at
\ndate-time
Timestamp of when the account integration was created.
logs_config
\nobject
AWS Logs Collection config.
lambda_forwarder
\nobject
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.
lambdas
\n[string]
List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to [].
log_source_config
\nobject
Log source configuration.
tag_filters
\n[object]
List of AWS log source tag filters. Defaults to [].
source
\nstring
The AWS log source to which the tag filters defined in tags are applied.
tags
\n[string]
The AWS resource tags to filter on for the log source specified by source.
sources
\n[string]
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.
metrics_config
\nobject
AWS Metrics Collection config.
automute_enabled
\nboolean
Enable EC2 automute for AWS metrics. Defaults to true.
collect_cloudwatch_alarms
\nboolean
Enable CloudWatch alarms collection. Defaults to false.
collect_custom_metrics
\nboolean
Enable custom metrics collection. Defaults to false.
enabled
\nboolean
Enable AWS metrics collection. Defaults to true.
metric_name_filters
\n[ <oneOf>]
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.
Option 1
\nobject
Include only metric names matching one of these patterns for a single namespace.
include_only [required]
\n[string]
Include only metric names matching one of these patterns.
namespace [required]
\nstring
The AWS CloudWatch namespace to which this metric name filter applies.
Option 2
\nobject
Exclude metric names matching one of these patterns for a single namespace.
exclude_only [required]
\n[string]
Exclude metric names matching one of these patterns.
namespace [required]
\nstring
The AWS CloudWatch namespace to which this metric name filter applies.
namespace_filters
\n<oneOf>
AWS Metrics namespace filters. Defaults to exclude_only.
Option 1
\nobject
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.
exclude_only [required]
\n[string]
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.
Option 2
\nobject
Include only these namespaces.
include_only [required]
\n[string]
Include only these namespaces.
tag_filters
\n[object]
AWS Metrics collection tag filters list. Defaults to [].
namespace
\nstring
The AWS service for which the tag filters defined in tags will be applied.
tags
\n[string]
The AWS resource tags to filter on for the service specified by namespace.
modified_at
\ndate-time
Timestamp of when the account integration was updated.
resources_config
\nobject
AWS Resources Collection config.
cloud_security_posture_management_collection
\nboolean
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.
extended_collection
\nboolean
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.
traces_config
\nobject
AWS Traces Collection config.
xray_services
\n<oneOf>
AWS X-Ray services to collect traces from. Defaults to include_only.
Option 1
\nobject
Include all services.
include_all [required]
\nboolean
Include all services.
Option 2
\nobject
Include only these services. Defaults to [].
include_only [required]
\n[string]
Include only these services.
id [required]
\nstring
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.
type [required]
\nenum
AWS Account resource type. \nAllowed enum values: account
default: account
data [required]
\nobject
AWS Account Update Request data.
attributes [required]
\nobject
The AWS Account Integration Config to be updated.
account_tags
\n[string]
Tags to apply to all hosts and metrics reporting for this account. Defaults to [].
auth_config
\n<oneOf>
AWS Authentication config.
Option 1
\nobject
AWS Authentication config to integrate your account using an access key pair.
access_key_id [required]
\nstring
AWS Access Key ID.
secret_access_key
\nstring
AWS Secret Access Key.
Option 2
\nobject
AWS Authentication config to integrate your account using an IAM role.
external_id
\nstring
AWS IAM External ID for associated role.
role_name [required]
\nstring
AWS IAM Role name.
aws_account_id [required]
\nstring
AWS Account ID.
aws_partition
\nenum
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
aws_regions
\n<oneOf>
AWS Regions to collect data from. Defaults to include_all.
Option 1
\nobject
Include all regions. Defaults to true.
include_all [required]
\nboolean
Include all regions.
Option 2
\nobject
Include only these regions.
include_only [required]
\n[string]
Include only these regions.
logs_config
\nobject
AWS Logs Collection config.
lambda_forwarder
\nobject
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.
lambdas
\n[string]
List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to [].
log_source_config
\nobject
Log source configuration.
tag_filters
\n[object]
List of AWS log source tag filters. Defaults to [].
source
\nstring
The AWS log source to which the tag filters defined in tags are applied.
tags
\n[string]
The AWS resource tags to filter on for the log source specified by source.
sources
\n[string]
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.
metrics_config
\nobject
AWS Metrics Collection config.
automute_enabled
\nboolean
Enable EC2 automute for AWS metrics. Defaults to true.
collect_cloudwatch_alarms
\nboolean
Enable CloudWatch alarms collection. Defaults to false.
collect_custom_metrics
\nboolean
Enable custom metrics collection. Defaults to false.
enabled
\nboolean
Enable AWS metrics collection. Defaults to true.
namespace_filters
\n<oneOf>
AWS Metrics namespace filters. Defaults to exclude_only.
Option 1
\nobject
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.
exclude_only [required]
\n[string]
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.
Option 2
\nobject
Include only these namespaces.
include_only [required]
\n[string]
Include only these namespaces.
tag_filters
\n[object]
AWS Metrics collection tag filters list. Defaults to [].
namespace
\nstring
The AWS service for which the tag filters defined in tags will be applied.
tags
\n[string]
The AWS resource tags to filter on for the service specified by namespace.
resources_config
\nobject
AWS Resources Collection config.
cloud_security_posture_management_collection
\nboolean
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.
extended_collection
\nboolean
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.
traces_config
\nobject
AWS Traces Collection config.
xray_services
\n<oneOf>
AWS X-Ray services to collect traces from. Defaults to include_only.
Option 1
\nobject
Include all services.
include_all [required]
\nboolean
Include all services.
Option 2
\nobject
Include only these services. Defaults to [].
include_only [required]
\n[string]
Include only these services.
id
\nstring
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.
type [required]
\nenum
AWS Account resource type. \nAllowed enum values: account
default: account
data [required]
\nobject
AWS Account Update Request data.
attributes [required]
\nobject
The AWS Account Integration Config to be updated.
account_tags
\n[string]
Tags to apply to all hosts and metrics reporting for this account. Defaults to [].
auth_config
\n<oneOf>
AWS Authentication config.
Option 1
\nobject
AWS Authentication config to integrate your account using an access key pair.
access_key_id [required]
\nstring
AWS Access Key ID.
secret_access_key
\nstring
AWS Secret Access Key.
Option 2
\nobject
AWS Authentication config to integrate your account using an IAM role.
external_id
\nstring
AWS IAM External ID for associated role.
role_name [required]
\nstring
AWS IAM Role name.
aws_account_id [required]
\nstring
AWS Account ID.
aws_partition
\nenum
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
aws_regions
\n<oneOf>
AWS Regions to collect data from. Defaults to include_all.
Option 1
\nobject
Include all regions. Defaults to true.
include_all [required]
\nboolean
Include all regions.
Option 2
\nobject
Include only these regions.
include_only [required]
\n[string]
Include only these regions.
logs_config
\nobject
AWS Logs Collection config.
lambda_forwarder
\nobject
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.
lambdas
\n[string]
List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to [].
log_source_config
\nobject
Log source configuration.
tag_filters
\n[object]
List of AWS log source tag filters. Defaults to [].
source
\nstring
The AWS log source to which the tag filters defined in tags are applied.
tags
\n[string]
The AWS resource tags to filter on for the log source specified by source.
sources
\n[string]
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.
metrics_config
\nobject
AWS Metrics Collection config.
automute_enabled
\nboolean
Enable EC2 automute for AWS metrics. Defaults to true.
collect_cloudwatch_alarms
\nboolean
Enable CloudWatch alarms collection. Defaults to false.
collect_custom_metrics
\nboolean
Enable custom metrics collection. Defaults to false.
enabled
\nboolean
Enable AWS metrics collection. Defaults to true.
metric_name_filters
\n[ <oneOf>]
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.
Option 1
\nobject
Include only metric names matching one of these patterns for a single namespace.
include_only [required]
\n[string]
Include only metric names matching one of these patterns.
namespace [required]
\nstring
The AWS CloudWatch namespace to which this metric name filter applies.
Option 2
\nobject
Exclude metric names matching one of these patterns for a single namespace.
exclude_only [required]
\n[string]
Exclude metric names matching one of these patterns.
namespace [required]
\nstring
The AWS CloudWatch namespace to which this metric name filter applies.
namespace_filters
\n<oneOf>
AWS Metrics namespace filters. Defaults to exclude_only.
Option 1
\nobject
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.
exclude_only [required]
\n[string]
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.
Option 2
\nobject
Include only these namespaces.
include_only [required]
\n[string]
Include only these namespaces.
tag_filters
\n[object]
AWS Metrics collection tag filters list. Defaults to [].
namespace
\nstring
The AWS service for which the tag filters defined in tags will be applied.
tags
\n[string]
The AWS resource tags to filter on for the service specified by namespace.
resources_config
\nobject
AWS Resources Collection config.
cloud_security_posture_management_collection
\nboolean
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.
extended_collection
\nboolean
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.
traces_config
\nobject
AWS Traces Collection config.
xray_services
\n<oneOf>
AWS X-Ray services to collect traces from. Defaults to include_only.
Option 1
\nobject
Include all services.
include_all [required]
\nboolean
Include all services.
Option 2
\nobject
Include only these services. Defaults to [].
include_only [required]
\n[string]
Include only these services.
id
\nstring
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.
type [required]
\nenum
AWS Account resource type. \nAllowed enum values: account
default: account
data [required]
\nobject
AWS CCM Config Create/Update Request data.
attributes [required]
\nobject
AWS CCM Config attributes for Create/Update requests.
ccm_config [required]
\nobject
AWS Cloud Cost Management config.
data_export_configs [required]
\n[object]
List of data export configurations for Cost and Usage Reports.
bucket_name [required]
\nstring
Name of the S3 bucket where the Cost and Usage Report is stored.
bucket_region [required]
\nstring
AWS region of the S3 bucket.
report_name [required]
\nstring
Name of the Cost and Usage Report.
report_prefix [required]
\nstring
S3 prefix where the Cost and Usage Report is stored.
report_type [required]
\nstring
Type of the Cost and Usage Report. Currently only CUR2.0 is supported.
type [required]
\nenum
AWS CCM Config resource type. \nAllowed enum values: ccm_config
default: ccm_config
data [required]
\nobject
AWS metric name filter preview response data.
attributes [required]
\nobject
AWS metric name filter preview response attributes.
namespaces [required]
\n[object]
The list of namespaces affected by the previewed metric name filters.
filters [required]
\n[object]
The metric name filter patterns evaluated for this namespace and how many metrics they matched.
match_count [required]
\nint64
The number of Datadog metric names matched by this pattern.
pattern [required]
\nstring
The metric name filter pattern.
metrics [required]
\n[object]
The CloudWatch metrics collected for this namespace and whether each resulting\nDatadog metric is filtered.
cw_name [required]
\nstring
The CloudWatch metric name.
dd_names [required]
\n[object]
The Datadog metric names produced from this CloudWatch metric.
filtered [required]
\nboolean
Whether this Datadog metric name is filtered out.
name [required]
\nstring
The Datadog metric name.
namespace [required]
\nstring
The AWS CloudWatch namespace.
id [required]
\nstring
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.
type [required]
\nenum
The AWSMetricNameFilterPreviewResponseData type. \nAllowed enum values: metric_name_filter_preview
default: metric_name_filter_preview
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
AWS metric name filter preview response data.
attributes [required]
\nobject
AWS metric name filter preview response attributes.
namespaces [required]
\n[object]
The list of namespaces affected by the previewed metric name filters.
filters [required]
\n[object]
The metric name filter patterns evaluated for this namespace and how many metrics they matched.
match_count [required]
\nint64
The number of Datadog metric names matched by this pattern.
pattern [required]
\nstring
The metric name filter pattern.
metrics [required]
\n[object]
The CloudWatch metrics collected for this namespace and whether each resulting\nDatadog metric is filtered.
cw_name [required]
\nstring
The CloudWatch metric name.
dd_names [required]
\n[object]
The Datadog metric names produced from this CloudWatch metric.
filtered [required]
\nboolean
Whether this Datadog metric name is filtered out.
name [required]
\nstring
The Datadog metric name.
namespace [required]
\nstring
The AWS CloudWatch namespace.
id [required]
\nstring
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.
type [required]
\nenum
The AWSMetricNameFilterPreviewResponseData type. \nAllowed enum values: metric_name_filter_preview
default: metric_name_filter_preview
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
AWS metric name filter preview request data.
attributes [required]
\nobject
AWS metric name filter preview request attributes.
metric_name_filters [required]
\n[ <oneOf>]
The metric name filters to preview.
Option 1
\nobject
Include only metric names matching one of these patterns for a single namespace.
include_only [required]
\n[string]
Include only metric names matching one of these patterns.
namespace [required]
\nstring
The AWS CloudWatch namespace to which this metric name filter applies.
Option 2
\nobject
Exclude metric names matching one of these patterns for a single namespace.
exclude_only [required]
\n[string]
Exclude metric names matching one of these patterns.
namespace [required]
\nstring
The AWS CloudWatch namespace to which this metric name filter applies.
type [required]
\nenum
The AWSMetricNameFilterPreviewResponseData type. \nAllowed enum values: metric_name_filter_preview
default: metric_name_filter_preview
data
\nobject
Represents the data for a single escalation policy, including its attributes, ID, relationships, and resource type.
attributes
\nobject
Defines the main attributes of an escalation policy, such as its name and behavior on policy end.
name [required]
\nstring
Specifies the name of the escalation policy.
resolve_page_on_policy_end
\nboolean
Indicates whether the page is automatically resolved when the policy ends.
retries
\nint64
Specifies how many times the escalation sequence is retried if there is no response.
id
\nstring
Specifies the unique identifier of the escalation policy.
relationships
\nobject
Represents the relationships for an escalation policy, including references to steps and teams.
steps [required]
\nobject
Defines the relationship to a collection of steps within an escalation policy. Contains an array of step data references.
data
\n[object]
An array of references to the steps defined in this escalation policy.
id [required]
\nstring
Specifies the unique identifier for the step resource.
type [required]
\nenum
Indicates that the resource is of type steps. \nAllowed enum values: steps
default: steps
teams
\nobject
Associates teams with this schedule in a data structure.
data
\n[object]
An array of team references for this schedule.
id [required]
\nstring
The unique identifier of the team in this relationship.
type [required]
\nenum
Teams resource type. \nAllowed enum values: teams
default: teams
type [required]
\nenum
Indicates that the resource is of type policies. \nAllowed enum values: policies
default: policies
included
\n[ <oneOf>]
Provides any included related resources, such as steps or targets, returned with the policy.
Option 1
\nobject
Represents a single step in an escalation policy, including its attributes, relationships, and resource type.
attributes
\nobject
Defines attributes for an escalation policy step, such as assignment strategy and escalation timeout.
assignment
\nenum
Specifies how this escalation step will assign targets (example default or round-robin). \nAllowed enum values: default,round-robin
escalate_after_seconds
\nint64
Specifies how many seconds to wait before escalating to the next step.
id
\nstring
Specifies the unique identifier of this escalation policy step.
relationships
\nobject
Represents the relationship of an escalation policy step to its targets.
targets
\nobject
A list of escalation targets for a step
data
\n[ <oneOf>]
The EscalationTargets data.
Option 1
\nobject
Represents a team target for an escalation policy step, including the team's ID and resource type.
id [required]
\nstring
Specifies the unique identifier of the team resource.
type [required]
\nenum
Indicates that the resource is of type teams. \nAllowed enum values: teams
default: teams
Option 2
\nobject
Represents a user target for an escalation policy step, including the user's ID and resource type.
id [required]
\nstring
Specifies the unique identifier of the user resource.
type [required]
\nenum
Indicates that the resource is of type users. \nAllowed enum values: users
default: users
Option 3
\nobject
Represents a schedule target for an escalation policy step, including its ID and resource type. This is a shortcut for a configured schedule target with position set to 'current'.
id [required]
\nstring
Specifies the unique identifier of the schedule resource.
type [required]
\nenum
Indicates that the resource is of type schedules. \nAllowed enum values: schedules
default: schedules
Option 4
\nobject
Relationship reference to a configured schedule target.
id [required]
\nstring
Specifies the unique identifier of the configured schedule target.
type [required]
\nenum
Indicates that the resource is of type schedule_target. \nAllowed enum values: schedule_target
default: schedule_target
type [required]
\nenum
Indicates that the resource is of type steps. \nAllowed enum values: steps
default: steps
Option 2
\nobject
Represents a user object in the context of an escalation policy, including their id, type, and basic attributes.
attributes
\nobject
Provides basic user information for an escalation policy, including a name and email address.
string
The user's email address.
name
\nstring
The user's name.
status
\nenum
The user's status. \nAllowed enum values: active,deactivated,pending
id
\nstring
The unique user identifier.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 3
\nobject
Represents the primary data object for a schedule, linking attributes and relationships.
attributes
\nobject
Provides core properties of a schedule object such as its name and time zone.
name
\nstring
A short name for the schedule.
time_zone
\nstring
The time zone in which this schedule operates.
id
\nstring
The schedule's unique identifier.
relationships
\nobject
Groups the relationships for a schedule object, referencing layers and teams.
layers
\nobject
Associates layers with this schedule in a data structure.
data
\n[object]
An array of layer references for this schedule.
id [required]
\nstring
The unique identifier of the layer in this relationship.
type [required]
\nenum
Layers resource type. \nAllowed enum values: layers
default: layers
teams
\nobject
Associates teams with this schedule in a data structure.
data
\n[object]
An array of team references for this schedule.
id [required]
\nstring
The unique identifier of the team in this relationship.
type [required]
\nenum
Teams resource type. \nAllowed enum values: teams
default: teams
type [required]
\nenum
Schedules resource type. \nAllowed enum values: schedules
default: schedules
Option 4
\nobject
Full resource representation of a configured schedule target with position (previous, current, or next).
attributes [required]
\nobject
Attributes for a configured schedule target, including position.
position [required]
\nenum
Specifies the position of a schedule target (example previous, current, or next). \nAllowed enum values: previous,current,next
id [required]
\nstring
Specifies the unique identifier of the configured schedule target.
relationships [required]
\nobject
Represents the relationships of a configured schedule target.
schedule [required]
\nobject
Holds the schedule reference for a configured schedule target.
data [required]
\nobject
Represents a schedule target for an escalation policy step, including its ID and resource type. This is a shortcut for a configured schedule target with position set to 'current'.
id [required]
\nstring
Specifies the unique identifier of the schedule resource.
type [required]
\nenum
Indicates that the resource is of type schedules. \nAllowed enum values: schedules
default: schedules
type [required]
\nenum
Indicates that the resource is of type schedule_target. \nAllowed enum values: schedule_target
default: schedule_target
Option 5
\nobject
Provides a reference to a team, including ID, type, and basic attributes/relationships.
attributes
\nobject
Encapsulates the basic attributes of a Team reference, such as name, handle, and an optional avatar or description.
avatar
\nstring
URL or reference for the team's avatar (if available).
description
\nstring
A short text describing the team.
handle
\nstring
A unique handle/slug for the team.
name
\nstring
The full, human-readable name of the team.
id
\nstring
The team's unique identifier.
type [required]
\nenum
Teams resource type. \nAllowed enum values: teams
default: teams
data
\nobject
Represents the data for a single escalation policy, including its attributes, ID, relationships, and resource type.
attributes
\nobject
Defines the main attributes of an escalation policy, such as its name and behavior on policy end.
name [required]
\nstring
Specifies the name of the escalation policy.
resolve_page_on_policy_end
\nboolean
Indicates whether the page is automatically resolved when the policy ends.
retries
\nint64
Specifies how many times the escalation sequence is retried if there is no response.
id
\nstring
Specifies the unique identifier of the escalation policy.
relationships
\nobject
Represents the relationships for an escalation policy, including references to steps and teams.
steps [required]
\nobject
Defines the relationship to a collection of steps within an escalation policy. Contains an array of step data references.
data
\n[object]
An array of references to the steps defined in this escalation policy.
id [required]
\nstring
Specifies the unique identifier for the step resource.
type [required]
\nenum
Indicates that the resource is of type steps. \nAllowed enum values: steps
default: steps
teams
\nobject
Associates teams with this schedule in a data structure.
data
\n[object]
An array of team references for this schedule.
id [required]
\nstring
The unique identifier of the team in this relationship.
type [required]
\nenum
Teams resource type. \nAllowed enum values: teams
default: teams
type [required]
\nenum
Indicates that the resource is of type policies. \nAllowed enum values: policies
default: policies
included
\n[ <oneOf>]
Provides any included related resources, such as steps or targets, returned with the policy.
Option 1
\nobject
Represents a single step in an escalation policy, including its attributes, relationships, and resource type.
attributes
\nobject
Defines attributes for an escalation policy step, such as assignment strategy and escalation timeout.
assignment
\nenum
Specifies how this escalation step will assign targets (example default or round-robin). \nAllowed enum values: default,round-robin
escalate_after_seconds
\nint64
Specifies how many seconds to wait before escalating to the next step.
id
\nstring
Specifies the unique identifier of this escalation policy step.
relationships
\nobject
Represents the relationship of an escalation policy step to its targets.
targets
\nobject
A list of escalation targets for a step
data
\n[ <oneOf>]
The EscalationTargets data.
Option 1
\nobject
Represents a team target for an escalation policy step, including the team's ID and resource type.
id [required]
\nstring
Specifies the unique identifier of the team resource.
type [required]
\nenum
Indicates that the resource is of type teams. \nAllowed enum values: teams
default: teams
Option 2
\nobject
Represents a user target for an escalation policy step, including the user's ID and resource type.
id [required]
\nstring
Specifies the unique identifier of the user resource.
type [required]
\nenum
Indicates that the resource is of type users. \nAllowed enum values: users
default: users
Option 3
\nobject
Represents a schedule target for an escalation policy step, including its ID and resource type. This is a shortcut for a configured schedule target with position set to 'current'.
id [required]
\nstring
Specifies the unique identifier of the schedule resource.
type [required]
\nenum
Indicates that the resource is of type schedules. \nAllowed enum values: schedules
default: schedules
Option 4
\nobject
Relationship reference to a configured schedule target.
id [required]
\nstring
Specifies the unique identifier of the configured schedule target.
type [required]
\nenum
Indicates that the resource is of type schedule_target. \nAllowed enum values: schedule_target
default: schedule_target
type [required]
\nenum
Indicates that the resource is of type steps. \nAllowed enum values: steps
default: steps
Option 2
\nobject
Represents a user object in the context of an escalation policy, including their id, type, and basic attributes.
attributes
\nobject
Provides basic user information for an escalation policy, including a name and email address.
string
The user's email address.
name
\nstring
The user's name.
status
\nenum
The user's status. \nAllowed enum values: active,deactivated,pending
id
\nstring
The unique user identifier.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 3
\nobject
Represents the primary data object for a schedule, linking attributes and relationships.
attributes
\nobject
Provides core properties of a schedule object such as its name and time zone.
name
\nstring
A short name for the schedule.
tags
\n[string]
A list of tags associated with the schedule.
time_zone
\nstring
The time zone in which this schedule operates.
id
\nstring
The schedule's unique identifier.
relationships
\nobject
Groups the relationships for a schedule object, referencing layers and teams.
layers
\nobject
Associates layers with this schedule in a data structure.
data
\n[object]
An array of layer references for this schedule.
id [required]
\nstring
The unique identifier of the layer in this relationship.
type [required]
\nenum
Layers resource type. \nAllowed enum values: layers
default: layers
teams
\nobject
Associates teams with this schedule in a data structure.
data
\n[object]
An array of team references for this schedule.
id [required]
\nstring
The unique identifier of the team in this relationship.
type [required]
\nenum
Teams resource type. \nAllowed enum values: teams
default: teams
type [required]
\nenum
Schedules resource type. \nAllowed enum values: schedules
default: schedules
Option 4
\nobject
Full resource representation of a configured schedule target with position (previous, current, or next).
attributes [required]
\nobject
Attributes for a configured schedule target, including position.
position [required]
\nenum
Specifies the position of a schedule target (example previous, current, or next). \nAllowed enum values: previous,current,next
id [required]
\nstring
Specifies the unique identifier of the configured schedule target.
relationships [required]
\nobject
Represents the relationships of a configured schedule target.
schedule [required]
\nobject
Holds the schedule reference for a configured schedule target.
data [required]
\nobject
Represents a schedule target for an escalation policy step, including its ID and resource type. This is a shortcut for a configured schedule target with position set to 'current'.
id [required]
\nstring
Specifies the unique identifier of the schedule resource.
type [required]
\nenum
Indicates that the resource is of type schedules. \nAllowed enum values: schedules
default: schedules
type [required]
\nenum
Indicates that the resource is of type schedule_target. \nAllowed enum values: schedule_target
default: schedule_target
Option 5
\nobject
Provides a reference to a team, including ID, type, and basic attributes/relationships.
attributes
\nobject
Encapsulates the basic attributes of a Team reference, such as name, handle, and an optional avatar or description.
avatar
\nstring
URL or reference for the team's avatar (if available).
description
\nstring
A short text describing the team.
handle
\nstring
A unique handle/slug for the team.
name
\nstring
The full, human-readable name of the team.
id
\nstring
The team's unique identifier.
type [required]
\nenum
Teams resource type. \nAllowed enum values: teams
default: teams
data
\nobject
Represents the data for a single escalation policy, including its attributes, ID, relationships, and resource type.
attributes
\nobject
Defines the main attributes of an escalation policy, such as its name and behavior on policy end.
name [required]
\nstring
Specifies the name of the escalation policy.
resolve_page_on_policy_end
\nboolean
Indicates whether the page is automatically resolved when the policy ends.
retries
\nint64
Specifies how many times the escalation sequence is retried if there is no response.
id
\nstring
Specifies the unique identifier of the escalation policy.
relationships
\nobject
Represents the relationships for an escalation policy, including references to steps and teams.
steps [required]
\nobject
Defines the relationship to a collection of steps within an escalation policy. Contains an array of step data references.
data
\n[object]
An array of references to the steps defined in this escalation policy.
id [required]
\nstring
Specifies the unique identifier for the step resource.
type [required]
\nenum
Indicates that the resource is of type steps. \nAllowed enum values: steps
default: steps
teams
\nobject
Associates teams with this schedule in a data structure.
data
\n[object]
An array of team references for this schedule.
id [required]
\nstring
The unique identifier of the team in this relationship.
type [required]
\nenum
Teams resource type. \nAllowed enum values: teams
default: teams
type [required]
\nenum
Indicates that the resource is of type policies. \nAllowed enum values: policies
default: policies
included
\n[ <oneOf>]
Provides any included related resources, such as steps or targets, returned with the policy.
Option 1
\nobject
Represents a single step in an escalation policy, including its attributes, relationships, and resource type.
attributes
\nobject
Defines attributes for an escalation policy step, such as assignment strategy and escalation timeout.
assignment
\nenum
Specifies how this escalation step will assign targets (example default or round-robin). \nAllowed enum values: default,round-robin
escalate_after_seconds
\nint64
Specifies how many seconds to wait before escalating to the next step.
id
\nstring
Specifies the unique identifier of this escalation policy step.
relationships
\nobject
Represents the relationship of an escalation policy step to its targets.
targets
\nobject
A list of escalation targets for a step
data
\n[ <oneOf>]
The EscalationTargets data.
Option 1
\nobject
Represents a team target for an escalation policy step, including the team's ID and resource type.
id [required]
\nstring
Specifies the unique identifier of the team resource.
type [required]
\nenum
Indicates that the resource is of type teams. \nAllowed enum values: teams
default: teams
Option 2
\nobject
Represents a user target for an escalation policy step, including the user's ID and resource type.
id [required]
\nstring
Specifies the unique identifier of the user resource.
type [required]
\nenum
Indicates that the resource is of type users. \nAllowed enum values: users
default: users
Option 3
\nobject
Represents a schedule target for an escalation policy step, including its ID and resource type. This is a shortcut for a configured schedule target with position set to 'current'.
id [required]
\nstring
Specifies the unique identifier of the schedule resource.
type [required]
\nenum
Indicates that the resource is of type schedules. \nAllowed enum values: schedules
default: schedules
Option 4
\nobject
Relationship reference to a configured schedule target.
id [required]
\nstring
Specifies the unique identifier of the configured schedule target.
type [required]
\nenum
Indicates that the resource is of type schedule_target. \nAllowed enum values: schedule_target
default: schedule_target
type [required]
\nenum
Indicates that the resource is of type steps. \nAllowed enum values: steps
default: steps
Option 2
\nobject
Represents a user object in the context of an escalation policy, including their id, type, and basic attributes.
attributes
\nobject
Provides basic user information for an escalation policy, including a name and email address.
string
The user's email address.
name
\nstring
The user's name.
status
\nenum
The user's status. \nAllowed enum values: active,deactivated,pending
id
\nstring
The unique user identifier.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 3
\nobject
Represents the primary data object for a schedule, linking attributes and relationships.
attributes
\nobject
Provides core properties of a schedule object such as its name and time zone.
name
\nstring
A short name for the schedule.
time_zone
\nstring
The time zone in which this schedule operates.
id
\nstring
The schedule's unique identifier.
relationships
\nobject
Groups the relationships for a schedule object, referencing layers and teams.
layers
\nobject
Associates layers with this schedule in a data structure.
data
\n[object]
An array of layer references for this schedule.
id [required]
\nstring
The unique identifier of the layer in this relationship.
type [required]
\nenum
Layers resource type. \nAllowed enum values: layers
default: layers
teams
\nobject
Associates teams with this schedule in a data structure.
data
\n[object]
An array of team references for this schedule.
id [required]
\nstring
The unique identifier of the team in this relationship.
type [required]
\nenum
Teams resource type. \nAllowed enum values: teams
default: teams
type [required]
\nenum
Schedules resource type. \nAllowed enum values: schedules
default: schedules
Option 4
\nobject
Full resource representation of a configured schedule target with position (previous, current, or next).
attributes [required]
\nobject
Attributes for a configured schedule target, including position.
position [required]
\nenum
Specifies the position of a schedule target (example previous, current, or next). \nAllowed enum values: previous,current,next
id [required]
\nstring
Specifies the unique identifier of the configured schedule target.
relationships [required]
\nobject
Represents the relationships of a configured schedule target.
schedule [required]
\nobject
Holds the schedule reference for a configured schedule target.
data [required]
\nobject
Represents a schedule target for an escalation policy step, including its ID and resource type. This is a shortcut for a configured schedule target with position set to 'current'.
id [required]
\nstring
Specifies the unique identifier of the schedule resource.
type [required]
\nenum
Indicates that the resource is of type schedules. \nAllowed enum values: schedules
default: schedules
type [required]
\nenum
Indicates that the resource is of type schedule_target. \nAllowed enum values: schedule_target
default: schedule_target
Option 5
\nobject
Provides a reference to a team, including ID, type, and basic attributes/relationships.
attributes
\nobject
Encapsulates the basic attributes of a Team reference, such as name, handle, and an optional avatar or description.
avatar
\nstring
URL or reference for the team's avatar (if available).
description
\nstring
A short text describing the team.
handle
\nstring
A unique handle/slug for the team.
name
\nstring
The full, human-readable name of the team.
id
\nstring
The team's unique identifier.
type [required]
\nenum
Teams resource type. \nAllowed enum values: teams
default: teams
data
\nobject
Represents the data for a single escalation policy, including its attributes, ID, relationships, and resource type.
attributes
\nobject
Defines the main attributes of an escalation policy, such as its name and behavior on policy end.
name [required]
\nstring
Specifies the name of the escalation policy.
resolve_page_on_policy_end
\nboolean
Indicates whether the page is automatically resolved when the policy ends.
retries
\nint64
Specifies how many times the escalation sequence is retried if there is no response.
id
\nstring
Specifies the unique identifier of the escalation policy.
relationships
\nobject
Represents the relationships for an escalation policy, including references to steps and teams.
steps [required]
\nobject
Defines the relationship to a collection of steps within an escalation policy. Contains an array of step data references.
data
\n[object]
An array of references to the steps defined in this escalation policy.
id [required]
\nstring
Specifies the unique identifier for the step resource.
type [required]
\nenum
Indicates that the resource is of type steps. \nAllowed enum values: steps
default: steps
teams
\nobject
Associates teams with this schedule in a data structure.
data
\n[object]
An array of team references for this schedule.
id [required]
\nstring
The unique identifier of the team in this relationship.
type [required]
\nenum
Teams resource type. \nAllowed enum values: teams
default: teams
type [required]
\nenum
Indicates that the resource is of type policies. \nAllowed enum values: policies
default: policies
included
\n[ <oneOf>]
Provides any included related resources, such as steps or targets, returned with the policy.
Option 1
\nobject
Represents a single step in an escalation policy, including its attributes, relationships, and resource type.
attributes
\nobject
Defines attributes for an escalation policy step, such as assignment strategy and escalation timeout.
assignment
\nenum
Specifies how this escalation step will assign targets (example default or round-robin). \nAllowed enum values: default,round-robin
escalate_after_seconds
\nint64
Specifies how many seconds to wait before escalating to the next step.
id
\nstring
Specifies the unique identifier of this escalation policy step.
relationships
\nobject
Represents the relationship of an escalation policy step to its targets.
targets
\nobject
A list of escalation targets for a step
data
\n[ <oneOf>]
The EscalationTargets data.
Option 1
\nobject
Represents a team target for an escalation policy step, including the team's ID and resource type.
id [required]
\nstring
Specifies the unique identifier of the team resource.
type [required]
\nenum
Indicates that the resource is of type teams. \nAllowed enum values: teams
default: teams
Option 2
\nobject
Represents a user target for an escalation policy step, including the user's ID and resource type.
id [required]
\nstring
Specifies the unique identifier of the user resource.
type [required]
\nenum
Indicates that the resource is of type users. \nAllowed enum values: users
default: users
Option 3
\nobject
Represents a schedule target for an escalation policy step, including its ID and resource type. This is a shortcut for a configured schedule target with position set to 'current'.
id [required]
\nstring
Specifies the unique identifier of the schedule resource.
type [required]
\nenum
Indicates that the resource is of type schedules. \nAllowed enum values: schedules
default: schedules
Option 4
\nobject
Relationship reference to a configured schedule target.
id [required]
\nstring
Specifies the unique identifier of the configured schedule target.
type [required]
\nenum
Indicates that the resource is of type schedule_target. \nAllowed enum values: schedule_target
default: schedule_target
type [required]
\nenum
Indicates that the resource is of type steps. \nAllowed enum values: steps
default: steps
Option 2
\nobject
Represents a user object in the context of an escalation policy, including their id, type, and basic attributes.
attributes
\nobject
Provides basic user information for an escalation policy, including a name and email address.
string
The user's email address.
name
\nstring
The user's name.
status
\nenum
The user's status. \nAllowed enum values: active,deactivated,pending
id
\nstring
The unique user identifier.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 3
\nobject
Represents the primary data object for a schedule, linking attributes and relationships.
attributes
\nobject
Provides core properties of a schedule object such as its name and time zone.
name
\nstring
A short name for the schedule.
tags
\n[string]
A list of tags associated with the schedule.
time_zone
\nstring
The time zone in which this schedule operates.
id
\nstring
The schedule's unique identifier.
relationships
\nobject
Groups the relationships for a schedule object, referencing layers and teams.
layers
\nobject
Associates layers with this schedule in a data structure.
data
\n[object]
An array of layer references for this schedule.
id [required]
\nstring
The unique identifier of the layer in this relationship.
type [required]
\nenum
Layers resource type. \nAllowed enum values: layers
default: layers
teams
\nobject
Associates teams with this schedule in a data structure.
data
\n[object]
An array of team references for this schedule.
id [required]
\nstring
The unique identifier of the team in this relationship.
type [required]
\nenum
Teams resource type. \nAllowed enum values: teams
default: teams
type [required]
\nenum
Schedules resource type. \nAllowed enum values: schedules
default: schedules
Option 4
\nobject
Full resource representation of a configured schedule target with position (previous, current, or next).
attributes [required]
\nobject
Attributes for a configured schedule target, including position.
position [required]
\nenum
Specifies the position of a schedule target (example previous, current, or next). \nAllowed enum values: previous,current,next
id [required]
\nstring
Specifies the unique identifier of the configured schedule target.
relationships [required]
\nobject
Represents the relationships of a configured schedule target.
schedule [required]
\nobject
Holds the schedule reference for a configured schedule target.
data [required]
\nobject
Represents a schedule target for an escalation policy step, including its ID and resource type. This is a shortcut for a configured schedule target with position set to 'current'.
id [required]
\nstring
Specifies the unique identifier of the schedule resource.
type [required]
\nenum
Indicates that the resource is of type schedules. \nAllowed enum values: schedules
default: schedules
type [required]
\nenum
Indicates that the resource is of type schedule_target. \nAllowed enum values: schedule_target
default: schedule_target
Option 5
\nobject
Provides a reference to a team, including ID, type, and basic attributes/relationships.
attributes
\nobject
Encapsulates the basic attributes of a Team reference, such as name, handle, and an optional avatar or description.
avatar
\nstring
URL or reference for the team's avatar (if available).
description
\nstring
A short text describing the team.
handle
\nstring
A unique handle/slug for the team.
name
\nstring
The full, human-readable name of the team.
id
\nstring
The team's unique identifier.
type [required]
\nenum
Teams resource type. \nAllowed enum values: teams
default: teams
data
\nobject
Represents the data for a single escalation policy, including its attributes, ID, relationships, and resource type.
attributes
\nobject
Defines the main attributes of an escalation policy, such as its name and behavior on policy end.
name [required]
\nstring
Specifies the name of the escalation policy.
resolve_page_on_policy_end
\nboolean
Indicates whether the page is automatically resolved when the policy ends.
retries
\nint64
Specifies how many times the escalation sequence is retried if there is no response.
id
\nstring
Specifies the unique identifier of the escalation policy.
relationships
\nobject
Represents the relationships for an escalation policy, including references to steps and teams.
steps [required]
\nobject
Defines the relationship to a collection of steps within an escalation policy. Contains an array of step data references.
data
\n[object]
An array of references to the steps defined in this escalation policy.
id [required]
\nstring
Specifies the unique identifier for the step resource.
type [required]
\nenum
Indicates that the resource is of type steps. \nAllowed enum values: steps
default: steps
teams
\nobject
Associates teams with this schedule in a data structure.
data
\n[object]
An array of team references for this schedule.
id [required]
\nstring
The unique identifier of the team in this relationship.
type [required]
\nenum
Teams resource type. \nAllowed enum values: teams
default: teams
type [required]
\nenum
Indicates that the resource is of type policies. \nAllowed enum values: policies
default: policies
included
\n[ <oneOf>]
Provides any included related resources, such as steps or targets, returned with the policy.
Option 1
\nobject
Represents a single step in an escalation policy, including its attributes, relationships, and resource type.
attributes
\nobject
Defines attributes for an escalation policy step, such as assignment strategy and escalation timeout.
assignment
\nenum
Specifies how this escalation step will assign targets (example default or round-robin). \nAllowed enum values: default,round-robin
escalate_after_seconds
\nint64
Specifies how many seconds to wait before escalating to the next step.
id
\nstring
Specifies the unique identifier of this escalation policy step.
relationships
\nobject
Represents the relationship of an escalation policy step to its targets.
targets
\nobject
A list of escalation targets for a step
data
\n[ <oneOf>]
The EscalationTargets data.
Option 1
\nobject
Represents a team target for an escalation policy step, including the team's ID and resource type.
id [required]
\nstring
Specifies the unique identifier of the team resource.
type [required]
\nenum
Indicates that the resource is of type teams. \nAllowed enum values: teams
default: teams
Option 2
\nobject
Represents a user target for an escalation policy step, including the user's ID and resource type.
id [required]
\nstring
Specifies the unique identifier of the user resource.
type [required]
\nenum
Indicates that the resource is of type users. \nAllowed enum values: users
default: users
Option 3
\nobject
Represents a schedule target for an escalation policy step, including its ID and resource type. This is a shortcut for a configured schedule target with position set to 'current'.
id [required]
\nstring
Specifies the unique identifier of the schedule resource.
type [required]
\nenum
Indicates that the resource is of type schedules. \nAllowed enum values: schedules
default: schedules
Option 4
\nobject
Relationship reference to a configured schedule target.
id [required]
\nstring
Specifies the unique identifier of the configured schedule target.
type [required]
\nenum
Indicates that the resource is of type schedule_target. \nAllowed enum values: schedule_target
default: schedule_target
type [required]
\nenum
Indicates that the resource is of type steps. \nAllowed enum values: steps
default: steps
Option 2
\nobject
Represents a user object in the context of an escalation policy, including their id, type, and basic attributes.
attributes
\nobject
Provides basic user information for an escalation policy, including a name and email address.
string
The user's email address.
name
\nstring
The user's name.
status
\nenum
The user's status. \nAllowed enum values: active,deactivated,pending
id
\nstring
The unique user identifier.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 3
\nobject
Represents the primary data object for a schedule, linking attributes and relationships.
attributes
\nobject
Provides core properties of a schedule object such as its name and time zone.
name
\nstring
A short name for the schedule.
time_zone
\nstring
The time zone in which this schedule operates.
id
\nstring
The schedule's unique identifier.
relationships
\nobject
Groups the relationships for a schedule object, referencing layers and teams.
layers
\nobject
Associates layers with this schedule in a data structure.
data
\n[object]
An array of layer references for this schedule.
id [required]
\nstring
The unique identifier of the layer in this relationship.
type [required]
\nenum
Layers resource type. \nAllowed enum values: layers
default: layers
teams
\nobject
Associates teams with this schedule in a data structure.
data
\n[object]
An array of team references for this schedule.
id [required]
\nstring
The unique identifier of the team in this relationship.
type [required]
\nenum
Teams resource type. \nAllowed enum values: teams
default: teams
type [required]
\nenum
Schedules resource type. \nAllowed enum values: schedules
default: schedules
Option 4
\nobject
Full resource representation of a configured schedule target with position (previous, current, or next).
attributes [required]
\nobject
Attributes for a configured schedule target, including position.
position [required]
\nenum
Specifies the position of a schedule target (example previous, current, or next). \nAllowed enum values: previous,current,next
id [required]
\nstring
Specifies the unique identifier of the configured schedule target.
relationships [required]
\nobject
Represents the relationships of a configured schedule target.
schedule [required]
\nobject
Holds the schedule reference for a configured schedule target.
data [required]
\nobject
Represents a schedule target for an escalation policy step, including its ID and resource type. This is a shortcut for a configured schedule target with position set to 'current'.
id [required]
\nstring
Specifies the unique identifier of the schedule resource.
type [required]
\nenum
Indicates that the resource is of type schedules. \nAllowed enum values: schedules
default: schedules
type [required]
\nenum
Indicates that the resource is of type schedule_target. \nAllowed enum values: schedule_target
default: schedule_target
Option 5
\nobject
Provides a reference to a team, including ID, type, and basic attributes/relationships.
attributes
\nobject
Encapsulates the basic attributes of a Team reference, such as name, handle, and an optional avatar or description.
avatar
\nstring
URL or reference for the team's avatar (if available).
description
\nstring
A short text describing the team.
handle
\nstring
A unique handle/slug for the team.
name
\nstring
The full, human-readable name of the team.
id
\nstring
The team's unique identifier.
type [required]
\nenum
Teams resource type. \nAllowed enum values: teams
default: teams
data
\nobject
Represents the data for a single escalation policy, including its attributes, ID, relationships, and resource type.
attributes
\nobject
Defines the main attributes of an escalation policy, such as its name and behavior on policy end.
name [required]
\nstring
Specifies the name of the escalation policy.
resolve_page_on_policy_end
\nboolean
Indicates whether the page is automatically resolved when the policy ends.
retries
\nint64
Specifies how many times the escalation sequence is retried if there is no response.
id
\nstring
Specifies the unique identifier of the escalation policy.
relationships
\nobject
Represents the relationships for an escalation policy, including references to steps and teams.
steps [required]
\nobject
Defines the relationship to a collection of steps within an escalation policy. Contains an array of step data references.
data
\n[object]
An array of references to the steps defined in this escalation policy.
id [required]
\nstring
Specifies the unique identifier for the step resource.
type [required]
\nenum
Indicates that the resource is of type steps. \nAllowed enum values: steps
default: steps
teams
\nobject
Associates teams with this schedule in a data structure.
data
\n[object]
An array of team references for this schedule.
id [required]
\nstring
The unique identifier of the team in this relationship.
type [required]
\nenum
Teams resource type. \nAllowed enum values: teams
default: teams
type [required]
\nenum
Indicates that the resource is of type policies. \nAllowed enum values: policies
default: policies
included
\n[ <oneOf>]
Provides any included related resources, such as steps or targets, returned with the policy.
Option 1
\nobject
Represents a single step in an escalation policy, including its attributes, relationships, and resource type.
attributes
\nobject
Defines attributes for an escalation policy step, such as assignment strategy and escalation timeout.
assignment
\nenum
Specifies how this escalation step will assign targets (example default or round-robin). \nAllowed enum values: default,round-robin
escalate_after_seconds
\nint64
Specifies how many seconds to wait before escalating to the next step.
id
\nstring
Specifies the unique identifier of this escalation policy step.
relationships
\nobject
Represents the relationship of an escalation policy step to its targets.
targets
\nobject
A list of escalation targets for a step
data
\n[ <oneOf>]
The EscalationTargets data.
Option 1
\nobject
Represents a team target for an escalation policy step, including the team's ID and resource type.
id [required]
\nstring
Specifies the unique identifier of the team resource.
type [required]
\nenum
Indicates that the resource is of type teams. \nAllowed enum values: teams
default: teams
Option 2
\nobject
Represents a user target for an escalation policy step, including the user's ID and resource type.
id [required]
\nstring
Specifies the unique identifier of the user resource.
type [required]
\nenum
Indicates that the resource is of type users. \nAllowed enum values: users
default: users
Option 3
\nobject
Represents a schedule target for an escalation policy step, including its ID and resource type. This is a shortcut for a configured schedule target with position set to 'current'.
id [required]
\nstring
Specifies the unique identifier of the schedule resource.
type [required]
\nenum
Indicates that the resource is of type schedules. \nAllowed enum values: schedules
default: schedules
Option 4
\nobject
Relationship reference to a configured schedule target.
id [required]
\nstring
Specifies the unique identifier of the configured schedule target.
type [required]
\nenum
Indicates that the resource is of type schedule_target. \nAllowed enum values: schedule_target
default: schedule_target
type [required]
\nenum
Indicates that the resource is of type steps. \nAllowed enum values: steps
default: steps
Option 2
\nobject
Represents a user object in the context of an escalation policy, including their id, type, and basic attributes.
attributes
\nobject
Provides basic user information for an escalation policy, including a name and email address.
string
The user's email address.
name
\nstring
The user's name.
status
\nenum
The user's status. \nAllowed enum values: active,deactivated,pending
id
\nstring
The unique user identifier.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
Option 3
\nobject
Represents the primary data object for a schedule, linking attributes and relationships.
attributes
\nobject
Provides core properties of a schedule object such as its name and time zone.
name
\nstring
A short name for the schedule.
tags
\n[string]
A list of tags associated with the schedule.
time_zone
\nstring
The time zone in which this schedule operates.
id
\nstring
The schedule's unique identifier.
relationships
\nobject
Groups the relationships for a schedule object, referencing layers and teams.
layers
\nobject
Associates layers with this schedule in a data structure.
data
\n[object]
An array of layer references for this schedule.
id [required]
\nstring
The unique identifier of the layer in this relationship.
type [required]
\nenum
Layers resource type. \nAllowed enum values: layers
default: layers
teams
\nobject
Associates teams with this schedule in a data structure.
data
\n[object]
An array of team references for this schedule.
id [required]
\nstring
The unique identifier of the team in this relationship.
type [required]
\nenum
Teams resource type. \nAllowed enum values: teams
default: teams
type [required]
\nenum
Schedules resource type. \nAllowed enum values: schedules
default: schedules
Option 4
\nobject
Full resource representation of a configured schedule target with position (previous, current, or next).
attributes [required]
\nobject
Attributes for a configured schedule target, including position.
position [required]
\nenum
Specifies the position of a schedule target (example previous, current, or next). \nAllowed enum values: previous,current,next
id [required]
\nstring
Specifies the unique identifier of the configured schedule target.
relationships [required]
\nobject
Represents the relationships of a configured schedule target.
schedule [required]
\nobject
Holds the schedule reference for a configured schedule target.
data [required]
\nobject
Represents a schedule target for an escalation policy step, including its ID and resource type. This is a shortcut for a configured schedule target with position set to 'current'.
id [required]
\nstring
Specifies the unique identifier of the schedule resource.
type [required]
\nenum
Indicates that the resource is of type schedules. \nAllowed enum values: schedules
default: schedules
type [required]
\nenum
Indicates that the resource is of type schedule_target. \nAllowed enum values: schedule_target
default: schedule_target
Option 5
\nobject
Provides a reference to a team, including ID, type, and basic attributes/relationships.
attributes
\nobject
Encapsulates the basic attributes of a Team reference, such as name, handle, and an optional avatar or description.
avatar
\nstring
URL or reference for the team's avatar (if available).
description
\nstring
A short text describing the team.
handle
\nstring
A unique handle/slug for the team.
name
\nstring
The full, human-readable name of the team.
id
\nstring
The team's unique identifier.
type [required]
\nenum
Teams resource type. \nAllowed enum values: teams
default: teams
data
\nobject
Represents the primary data object for a schedule, linking attributes and relationships.
attributes
\nobject
Provides core properties of a schedule object such as its name and time zone.
name
\nstring
A short name for the schedule.
time_zone
\nstring
The time zone in which this schedule operates.
id
\nstring
The schedule's unique identifier.
relationships
\nobject
Groups the relationships for a schedule object, referencing layers and teams.
layers
\nobject
Associates layers with this schedule in a data structure.
data
\n[object]
An array of layer references for this schedule.
id [required]
\nstring
The unique identifier of the layer in this relationship.
type [required]
\nenum
Layers resource type. \nAllowed enum values: layers
default: layers
teams
\nobject
Associates teams with this schedule in a data structure.
data
\n[object]
An array of team references for this schedule.
id [required]
\nstring
The unique identifier of the team in this relationship.
type [required]
\nenum
Teams resource type. \nAllowed enum values: teams
default: teams
type [required]
\nenum
Schedules resource type. \nAllowed enum values: schedules
default: schedules
included
\n[ <oneOf>]
Any additional resources related to this schedule, such as teams and layers.
Option 1
\nobject
Provides a reference to a team, including ID, type, and basic attributes/relationships.
attributes
\nobject
Encapsulates the basic attributes of a Team reference, such as name, handle, and an optional avatar or description.
avatar
\nstring
URL or reference for the team's avatar (if available).
description
\nstring
A short text describing the team.
handle
\nstring
A unique handle/slug for the team.
name
\nstring
The full, human-readable name of the team.
id
\nstring
The team's unique identifier.
type [required]
\nenum
Teams resource type. \nAllowed enum values: teams
default: teams
Option 2
\nobject
Encapsulates a layer resource, holding attributes like rotation details, plus relationships to the members covering that layer.
attributes
\nobject
Describes key properties of a Layer, including rotation details, name, start/end times, and any restrictions.
effective_date
\ndate-time
When the layer becomes active (ISO 8601).
end_date
\ndate-time
When the layer ceases to be active (ISO 8601).
interval
\nobject
Defines how often the rotation repeats, using a combination of days and optional seconds. Should be at least 1 hour.
days
\nint32
The number of days in each rotation cycle.
seconds
\nint64
Any additional seconds for the rotation cycle (up to 30 days).
name
\nstring
The name of this layer.
restrictions
\n[object]
An optional list of time restrictions for when this layer is in effect.
end_day
\nenum
A day of the week. \nAllowed enum values: monday,tuesday,wednesday,thursday,friday,saturday,sunday
end_time
\nstring
Specifies the ending time for this restriction.
start_day
\nenum
A day of the week. \nAllowed enum values: monday,tuesday,wednesday,thursday,friday,saturday,sunday
start_time
\nstring
Specifies the starting time for this restriction.
rotation_start
\ndate-time
The date/time when the rotation starts (ISO 8601).
time_zone
\nstring
The time zone for this layer.
id
\nstring
A unique identifier for this layer.
relationships
\nobject
Holds references to objects related to the Layer entity, such as its members.
members
\nobject
Holds an array of references to the members of a Layer, each containing member IDs.
data
\n[object]
The list of members who belong to this layer.
id [required]
\nstring
The unique user ID of the layer member.
type [required]
\nenum
Members resource type. \nAllowed enum values: members
default: members
type [required]
\nenum
Layers resource type. \nAllowed enum values: layers
default: layers
Option 3
\nobject
Represents a single member entry in a schedule, referencing a specific user.
id
\nstring
The unique identifier for this schedule member.
relationships
\nobject
Defines relationships for a schedule member, primarily referencing a single user.
user
\nobject
Wraps the user data reference for a schedule member.
data [required]
\nobject
Points to the user data associated with this schedule member, including an ID and type.
id [required]
\nstring
The user's unique identifier.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Schedule Members resource type. \nAllowed enum values: members
default: members
Option 4
\nobject
Represents a user object in the context of a schedule, including their id, type, and basic attributes.
attributes
\nobject
Provides basic user information for a schedule, including a name and email address.
string
The user's email address.
name
\nstring
The user's name.
status
\nenum
The user's status. \nAllowed enum values: active,deactivated,pending
id
\nstring
The unique user identifier.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
data
\nobject
Represents the primary data object for a schedule, linking attributes and relationships.
attributes
\nobject
Provides core properties of a schedule object such as its name and time zone.
name
\nstring
A short name for the schedule.
tags
\n[string]
A list of tags associated with the schedule.
time_zone
\nstring
The time zone in which this schedule operates.
id
\nstring
The schedule's unique identifier.
relationships
\nobject
Groups the relationships for a schedule object, referencing layers and teams.
layers
\nobject
Associates layers with this schedule in a data structure.
data
\n[object]
An array of layer references for this schedule.
id [required]
\nstring
The unique identifier of the layer in this relationship.
type [required]
\nenum
Layers resource type. \nAllowed enum values: layers
default: layers
teams
\nobject
Associates teams with this schedule in a data structure.
data
\n[object]
An array of team references for this schedule.
id [required]
\nstring
The unique identifier of the team in this relationship.
type [required]
\nenum
Teams resource type. \nAllowed enum values: teams
default: teams
type [required]
\nenum
Schedules resource type. \nAllowed enum values: schedules
default: schedules
included
\n[ <oneOf>]
Any additional resources related to this schedule, such as teams and layers.
Option 1
\nobject
Provides a reference to a team, including ID, type, and basic attributes/relationships.
attributes
\nobject
Encapsulates the basic attributes of a Team reference, such as name, handle, and an optional avatar or description.
avatar
\nstring
URL or reference for the team's avatar (if available).
description
\nstring
A short text describing the team.
handle
\nstring
A unique handle/slug for the team.
name
\nstring
The full, human-readable name of the team.
id
\nstring
The team's unique identifier.
type [required]
\nenum
Teams resource type. \nAllowed enum values: teams
default: teams
Option 2
\nobject
Encapsulates a layer resource, holding attributes like rotation details, plus relationships to the members covering that layer.
attributes
\nobject
Describes key properties of a Layer, including rotation details, name, start/end times, and any restrictions.
effective_date
\ndate-time
When the layer becomes active (ISO 8601).
end_date
\ndate-time
When the layer ceases to be active (ISO 8601).
interval
\nobject
Defines how often the rotation repeats, using a combination of days and optional seconds. Should be at least 1 hour.
days
\nint32
The number of days in each rotation cycle.
seconds
\nint64
Any additional seconds for the rotation cycle (up to 30 days).
name
\nstring
The name of this layer.
restrictions
\n[object]
An optional list of time restrictions for when this layer is in effect.
end_day
\nenum
A day of the week. \nAllowed enum values: monday,tuesday,wednesday,thursday,friday,saturday,sunday
end_time
\nstring
Specifies the ending time for this restriction.
start_day
\nenum
A day of the week. \nAllowed enum values: monday,tuesday,wednesday,thursday,friday,saturday,sunday
start_time
\nstring
Specifies the starting time for this restriction.
rotation_start
\ndate-time
The date/time when the rotation starts (ISO 8601).
time_zone
\nstring
The time zone for this layer.
id
\nstring
A unique identifier for this layer.
relationships
\nobject
Holds references to objects related to the Layer entity, such as its members.
members
\nobject
Holds an array of references to the members of a Layer, each containing member IDs.
data
\n[object]
The list of members who belong to this layer.
id [required]
\nstring
The unique user ID of the layer member.
type [required]
\nenum
Members resource type. \nAllowed enum values: members
default: members
type [required]
\nenum
Layers resource type. \nAllowed enum values: layers
default: layers
Option 3
\nobject
Represents a single member entry in a schedule, referencing a specific user.
id
\nstring
The unique identifier for this schedule member.
relationships
\nobject
Defines relationships for a schedule member, primarily referencing a single user.
user
\nobject
Wraps the user data reference for a schedule member.
data [required]
\nobject
Points to the user data associated with this schedule member, including an ID and type.
id [required]
\nstring
The user's unique identifier.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Schedule Members resource type. \nAllowed enum values: members
default: members
Option 4
\nobject
Represents a user object in the context of a schedule, including their id, type, and basic attributes.
attributes
\nobject
Provides basic user information for a schedule, including a name and email address.
string
The user's email address.
name
\nstring
The user's name.
status
\nenum
The user's status. \nAllowed enum values: active,deactivated,pending
id
\nstring
The unique user identifier.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
data
\nobject
Represents the primary data object for a schedule, linking attributes and relationships.
attributes
\nobject
Provides core properties of a schedule object such as its name and time zone.
name
\nstring
A short name for the schedule.
time_zone
\nstring
The time zone in which this schedule operates.
id
\nstring
The schedule's unique identifier.
relationships
\nobject
Groups the relationships for a schedule object, referencing layers and teams.
layers
\nobject
Associates layers with this schedule in a data structure.
data
\n[object]
An array of layer references for this schedule.
id [required]
\nstring
The unique identifier of the layer in this relationship.
type [required]
\nenum
Layers resource type. \nAllowed enum values: layers
default: layers
teams
\nobject
Associates teams with this schedule in a data structure.
data
\n[object]
An array of team references for this schedule.
id [required]
\nstring
The unique identifier of the team in this relationship.
type [required]
\nenum
Teams resource type. \nAllowed enum values: teams
default: teams
type [required]
\nenum
Schedules resource type. \nAllowed enum values: schedules
default: schedules
included
\n[ <oneOf>]
Any additional resources related to this schedule, such as teams and layers.
Option 1
\nobject
Provides a reference to a team, including ID, type, and basic attributes/relationships.
attributes
\nobject
Encapsulates the basic attributes of a Team reference, such as name, handle, and an optional avatar or description.
avatar
\nstring
URL or reference for the team's avatar (if available).
description
\nstring
A short text describing the team.
handle
\nstring
A unique handle/slug for the team.
name
\nstring
The full, human-readable name of the team.
id
\nstring
The team's unique identifier.
type [required]
\nenum
Teams resource type. \nAllowed enum values: teams
default: teams
Option 2
\nobject
Encapsulates a layer resource, holding attributes like rotation details, plus relationships to the members covering that layer.
attributes
\nobject
Describes key properties of a Layer, including rotation details, name, start/end times, and any restrictions.
effective_date
\ndate-time
When the layer becomes active (ISO 8601).
end_date
\ndate-time
When the layer ceases to be active (ISO 8601).
interval
\nobject
Defines how often the rotation repeats, using a combination of days and optional seconds. Should be at least 1 hour.
days
\nint32
The number of days in each rotation cycle.
seconds
\nint64
Any additional seconds for the rotation cycle (up to 30 days).
name
\nstring
The name of this layer.
restrictions
\n[object]
An optional list of time restrictions for when this layer is in effect.
end_day
\nenum
A day of the week. \nAllowed enum values: monday,tuesday,wednesday,thursday,friday,saturday,sunday
end_time
\nstring
Specifies the ending time for this restriction.
start_day
\nenum
A day of the week. \nAllowed enum values: monday,tuesday,wednesday,thursday,friday,saturday,sunday
start_time
\nstring
Specifies the starting time for this restriction.
rotation_start
\ndate-time
The date/time when the rotation starts (ISO 8601).
time_zone
\nstring
The time zone for this layer.
id
\nstring
A unique identifier for this layer.
relationships
\nobject
Holds references to objects related to the Layer entity, such as its members.
members
\nobject
Holds an array of references to the members of a Layer, each containing member IDs.
data
\n[object]
The list of members who belong to this layer.
id [required]
\nstring
The unique user ID of the layer member.
type [required]
\nenum
Members resource type. \nAllowed enum values: members
default: members
type [required]
\nenum
Layers resource type. \nAllowed enum values: layers
default: layers
Option 3
\nobject
Represents a single member entry in a schedule, referencing a specific user.
id
\nstring
The unique identifier for this schedule member.
relationships
\nobject
Defines relationships for a schedule member, primarily referencing a single user.
user
\nobject
Wraps the user data reference for a schedule member.
data [required]
\nobject
Points to the user data associated with this schedule member, including an ID and type.
id [required]
\nstring
The user's unique identifier.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Schedule Members resource type. \nAllowed enum values: members
default: members
Option 4
\nobject
Represents a user object in the context of a schedule, including their id, type, and basic attributes.
attributes
\nobject
Provides basic user information for a schedule, including a name and email address.
string
The user's email address.
name
\nstring
The user's name.
status
\nenum
The user's status. \nAllowed enum values: active,deactivated,pending
id
\nstring
The unique user identifier.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
data
\nobject
Represents the primary data object for a schedule, linking attributes and relationships.
attributes
\nobject
Provides core properties of a schedule object such as its name and time zone.
name
\nstring
A short name for the schedule.
tags
\n[string]
A list of tags associated with the schedule.
time_zone
\nstring
The time zone in which this schedule operates.
id
\nstring
The schedule's unique identifier.
relationships
\nobject
Groups the relationships for a schedule object, referencing layers and teams.
layers
\nobject
Associates layers with this schedule in a data structure.
data
\n[object]
An array of layer references for this schedule.
id [required]
\nstring
The unique identifier of the layer in this relationship.
type [required]
\nenum
Layers resource type. \nAllowed enum values: layers
default: layers
teams
\nobject
Associates teams with this schedule in a data structure.
data
\n[object]
An array of team references for this schedule.
id [required]
\nstring
The unique identifier of the team in this relationship.
type [required]
\nenum
Teams resource type. \nAllowed enum values: teams
default: teams
type [required]
\nenum
Schedules resource type. \nAllowed enum values: schedules
default: schedules
included
\n[ <oneOf>]
Any additional resources related to this schedule, such as teams and layers.
Option 1
\nobject
Provides a reference to a team, including ID, type, and basic attributes/relationships.
attributes
\nobject
Encapsulates the basic attributes of a Team reference, such as name, handle, and an optional avatar or description.
avatar
\nstring
URL or reference for the team's avatar (if available).
description
\nstring
A short text describing the team.
handle
\nstring
A unique handle/slug for the team.
name
\nstring
The full, human-readable name of the team.
id
\nstring
The team's unique identifier.
type [required]
\nenum
Teams resource type. \nAllowed enum values: teams
default: teams
Option 2
\nobject
Encapsulates a layer resource, holding attributes like rotation details, plus relationships to the members covering that layer.
attributes
\nobject
Describes key properties of a Layer, including rotation details, name, start/end times, and any restrictions.
effective_date
\ndate-time
When the layer becomes active (ISO 8601).
end_date
\ndate-time
When the layer ceases to be active (ISO 8601).
interval
\nobject
Defines how often the rotation repeats, using a combination of days and optional seconds. Should be at least 1 hour.
days
\nint32
The number of days in each rotation cycle.
seconds
\nint64
Any additional seconds for the rotation cycle (up to 30 days).
name
\nstring
The name of this layer.
restrictions
\n[object]
An optional list of time restrictions for when this layer is in effect.
end_day
\nenum
A day of the week. \nAllowed enum values: monday,tuesday,wednesday,thursday,friday,saturday,sunday
end_time
\nstring
Specifies the ending time for this restriction.
start_day
\nenum
A day of the week. \nAllowed enum values: monday,tuesday,wednesday,thursday,friday,saturday,sunday
start_time
\nstring
Specifies the starting time for this restriction.
rotation_start
\ndate-time
The date/time when the rotation starts (ISO 8601).
time_zone
\nstring
The time zone for this layer.
id
\nstring
A unique identifier for this layer.
relationships
\nobject
Holds references to objects related to the Layer entity, such as its members.
members
\nobject
Holds an array of references to the members of a Layer, each containing member IDs.
data
\n[object]
The list of members who belong to this layer.
id [required]
\nstring
The unique user ID of the layer member.
type [required]
\nenum
Members resource type. \nAllowed enum values: members
default: members
type [required]
\nenum
Layers resource type. \nAllowed enum values: layers
default: layers
Option 3
\nobject
Represents a single member entry in a schedule, referencing a specific user.
id
\nstring
The unique identifier for this schedule member.
relationships
\nobject
Defines relationships for a schedule member, primarily referencing a single user.
user
\nobject
Wraps the user data reference for a schedule member.
data [required]
\nobject
Points to the user data associated with this schedule member, including an ID and type.
id [required]
\nstring
The user's unique identifier.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Schedule Members resource type. \nAllowed enum values: members
default: members
Option 4
\nobject
Represents a user object in the context of a schedule, including their id, type, and basic attributes.
attributes
\nobject
Provides basic user information for a schedule, including a name and email address.
string
The user's email address.
name
\nstring
The user's name.
status
\nenum
The user's status. \nAllowed enum values: active,deactivated,pending
id
\nstring
The unique user identifier.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
data
\nobject
Represents the primary data object for a schedule, linking attributes and relationships.
attributes
\nobject
Provides core properties of a schedule object such as its name and time zone.
name
\nstring
A short name for the schedule.
time_zone
\nstring
The time zone in which this schedule operates.
id
\nstring
The schedule's unique identifier.
relationships
\nobject
Groups the relationships for a schedule object, referencing layers and teams.
layers
\nobject
Associates layers with this schedule in a data structure.
data
\n[object]
An array of layer references for this schedule.
id [required]
\nstring
The unique identifier of the layer in this relationship.
type [required]
\nenum
Layers resource type. \nAllowed enum values: layers
default: layers
teams
\nobject
Associates teams with this schedule in a data structure.
data
\n[object]
An array of team references for this schedule.
id [required]
\nstring
The unique identifier of the team in this relationship.
type [required]
\nenum
Teams resource type. \nAllowed enum values: teams
default: teams
type [required]
\nenum
Schedules resource type. \nAllowed enum values: schedules
default: schedules
included
\n[ <oneOf>]
Any additional resources related to this schedule, such as teams and layers.
Option 1
\nobject
Provides a reference to a team, including ID, type, and basic attributes/relationships.
attributes
\nobject
Encapsulates the basic attributes of a Team reference, such as name, handle, and an optional avatar or description.
avatar
\nstring
URL or reference for the team's avatar (if available).
description
\nstring
A short text describing the team.
handle
\nstring
A unique handle/slug for the team.
name
\nstring
The full, human-readable name of the team.
id
\nstring
The team's unique identifier.
type [required]
\nenum
Teams resource type. \nAllowed enum values: teams
default: teams
Option 2
\nobject
Encapsulates a layer resource, holding attributes like rotation details, plus relationships to the members covering that layer.
attributes
\nobject
Describes key properties of a Layer, including rotation details, name, start/end times, and any restrictions.
effective_date
\ndate-time
When the layer becomes active (ISO 8601).
end_date
\ndate-time
When the layer ceases to be active (ISO 8601).
interval
\nobject
Defines how often the rotation repeats, using a combination of days and optional seconds. Should be at least 1 hour.
days
\nint32
The number of days in each rotation cycle.
seconds
\nint64
Any additional seconds for the rotation cycle (up to 30 days).
name
\nstring
The name of this layer.
restrictions
\n[object]
An optional list of time restrictions for when this layer is in effect.
end_day
\nenum
A day of the week. \nAllowed enum values: monday,tuesday,wednesday,thursday,friday,saturday,sunday
end_time
\nstring
Specifies the ending time for this restriction.
start_day
\nenum
A day of the week. \nAllowed enum values: monday,tuesday,wednesday,thursday,friday,saturday,sunday
start_time
\nstring
Specifies the starting time for this restriction.
rotation_start
\ndate-time
The date/time when the rotation starts (ISO 8601).
time_zone
\nstring
The time zone for this layer.
id
\nstring
A unique identifier for this layer.
relationships
\nobject
Holds references to objects related to the Layer entity, such as its members.
members
\nobject
Holds an array of references to the members of a Layer, each containing member IDs.
data
\n[object]
The list of members who belong to this layer.
id [required]
\nstring
The unique user ID of the layer member.
type [required]
\nenum
Members resource type. \nAllowed enum values: members
default: members
type [required]
\nenum
Layers resource type. \nAllowed enum values: layers
default: layers
Option 3
\nobject
Represents a single member entry in a schedule, referencing a specific user.
id
\nstring
The unique identifier for this schedule member.
relationships
\nobject
Defines relationships for a schedule member, primarily referencing a single user.
user
\nobject
Wraps the user data reference for a schedule member.
data [required]
\nobject
Points to the user data associated with this schedule member, including an ID and type.
id [required]
\nstring
The user's unique identifier.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Schedule Members resource type. \nAllowed enum values: members
default: members
Option 4
\nobject
Represents a user object in the context of a schedule, including their id, type, and basic attributes.
attributes
\nobject
Provides basic user information for a schedule, including a name and email address.
string
The user's email address.
name
\nstring
The user's name.
status
\nenum
The user's status. \nAllowed enum values: active,deactivated,pending
id
\nstring
The unique user identifier.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
data
\nobject
Represents the primary data object for a schedule, linking attributes and relationships.
attributes
\nobject
Provides core properties of a schedule object such as its name and time zone.
name
\nstring
A short name for the schedule.
tags
\n[string]
A list of tags associated with the schedule.
time_zone
\nstring
The time zone in which this schedule operates.
id
\nstring
The schedule's unique identifier.
relationships
\nobject
Groups the relationships for a schedule object, referencing layers and teams.
layers
\nobject
Associates layers with this schedule in a data structure.
data
\n[object]
An array of layer references for this schedule.
id [required]
\nstring
The unique identifier of the layer in this relationship.
type [required]
\nenum
Layers resource type. \nAllowed enum values: layers
default: layers
teams
\nobject
Associates teams with this schedule in a data structure.
data
\n[object]
An array of team references for this schedule.
id [required]
\nstring
The unique identifier of the team in this relationship.
type [required]
\nenum
Teams resource type. \nAllowed enum values: teams
default: teams
type [required]
\nenum
Schedules resource type. \nAllowed enum values: schedules
default: schedules
included
\n[ <oneOf>]
Any additional resources related to this schedule, such as teams and layers.
Option 1
\nobject
Provides a reference to a team, including ID, type, and basic attributes/relationships.
attributes
\nobject
Encapsulates the basic attributes of a Team reference, such as name, handle, and an optional avatar or description.
avatar
\nstring
URL or reference for the team's avatar (if available).
description
\nstring
A short text describing the team.
handle
\nstring
A unique handle/slug for the team.
name
\nstring
The full, human-readable name of the team.
id
\nstring
The team's unique identifier.
type [required]
\nenum
Teams resource type. \nAllowed enum values: teams
default: teams
Option 2
\nobject
Encapsulates a layer resource, holding attributes like rotation details, plus relationships to the members covering that layer.
attributes
\nobject
Describes key properties of a Layer, including rotation details, name, start/end times, and any restrictions.
effective_date
\ndate-time
When the layer becomes active (ISO 8601).
end_date
\ndate-time
When the layer ceases to be active (ISO 8601).
interval
\nobject
Defines how often the rotation repeats, using a combination of days and optional seconds. Should be at least 1 hour.
days
\nint32
The number of days in each rotation cycle.
seconds
\nint64
Any additional seconds for the rotation cycle (up to 30 days).
name
\nstring
The name of this layer.
restrictions
\n[object]
An optional list of time restrictions for when this layer is in effect.
end_day
\nenum
A day of the week. \nAllowed enum values: monday,tuesday,wednesday,thursday,friday,saturday,sunday
end_time
\nstring
Specifies the ending time for this restriction.
start_day
\nenum
A day of the week. \nAllowed enum values: monday,tuesday,wednesday,thursday,friday,saturday,sunday
start_time
\nstring
Specifies the starting time for this restriction.
rotation_start
\ndate-time
The date/time when the rotation starts (ISO 8601).
time_zone
\nstring
The time zone for this layer.
id
\nstring
A unique identifier for this layer.
relationships
\nobject
Holds references to objects related to the Layer entity, such as its members.
members
\nobject
Holds an array of references to the members of a Layer, each containing member IDs.
data
\n[object]
The list of members who belong to this layer.
id [required]
\nstring
The unique user ID of the layer member.
type [required]
\nenum
Members resource type. \nAllowed enum values: members
default: members
type [required]
\nenum
Layers resource type. \nAllowed enum values: layers
default: layers
Option 3
\nobject
Represents a single member entry in a schedule, referencing a specific user.
id
\nstring
The unique identifier for this schedule member.
relationships
\nobject
Defines relationships for a schedule member, primarily referencing a single user.
user
\nobject
Wraps the user data reference for a schedule member.
data [required]
\nobject
Points to the user data associated with this schedule member, including an ID and type.
id [required]
\nstring
The user's unique identifier.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
type [required]
\nenum
Schedule Members resource type. \nAllowed enum values: members
default: members
Option 4
\nobject
Represents a user object in the context of a schedule, including their id, type, and basic attributes.
attributes
\nobject
Provides basic user information for a schedule, including a name and email address.
string
The user's email address.
name
\nstring
The user's name.
status
\nenum
The user's status. \nAllowed enum values: active,deactivated,pending
id
\nstring
The unique user identifier.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
data
\nobject
The main data object representing a schedule's on-call responders lookup, including relationships and metadata.
attributes
\nobject
Attributes for a schedule's on-call responders lookup.
scheduled_at
\ndate-time
The timestamp the responders were resolved at.
id
\nstring
Unique identifier of this on-call responders lookup.
relationships
\nobject
Relationships for a schedule's on-call responders lookup, including the schedule and its responder groups.
responders
\nobject
Defines the list of per-position (previous, current, next) responder groups for the schedule.
data
\n[object]
Array of references to the responder groups included in the response.
id [required]
\nstring
Unique identifier of the responder group.
type [required]
\nenum
Identifies the resource type for a responder group linked to a schedule's on-call responders lookup. \nAllowed enum values: schedule_oncall_responder
default: schedule_oncall_responder
schedule
\nobject
Defines the relationship to the schedule this on-call responders lookup was performed for.
data
\nobject
Represents a reference to the schedule this on-call responders lookup was performed for.
id [required]
\nstring
Unique identifier of the schedule.
type [required]
\nenum
Identifies the resource type for the schedule associated with this on-call responders lookup. \nAllowed enum values: schedules
default: schedules
type [required]
\nenum
Represents the resource type for a schedule's grouped on-call responders across the previous, current, and next positions. \nAllowed enum values: schedule_oncall_responders
default: schedule_oncall_responders
included
\n[ <oneOf>]
The ScheduleOnCallResponders included.
Option 1
\nobject
Represents one position's (previous, current, or next) group of on-call responder shifts. Positions with no matching shift are omitted entirely from the response.
attributes
\nobject
Attributes for one position's (previous, current, or next) group of on-call responder shifts.
position
\nenum
Specifies the position of a schedule target (example previous, current, or next). \nAllowed enum values: previous,current,next
id
\nstring
Unique identifier of this responder group.
relationships
\nobject
Relationships for a single position's (previous, current, or next) responder group.
shifts
\nobject
Defines the list of shifts satisfying this responder group's position. Multiple shifts occur when a schedule has concurrent on-call users at that position (additive schedules).
data
\n[object]
Array of references to the shifts included in the response.
id [required]
\nstring
Unique identifier of the shift.
type [required]
\nenum
Indicates that the related resource is of type shifts. \nAllowed enum values: shifts
default: shifts
type [required]
\nenum
Represents the resource type for a single position's (previous, current, or next) group of on-call responder shifts. \nAllowed enum values: schedule_oncall_responder
default: schedule_oncall_responder
Option 2
\nobject
Data for an on-call shift.
attributes
\nobject
Attributes for an on-call shift.
end
\ndate-time
The end time of the shift.
start
\ndate-time
The start time of the shift.
id
\nstring
The ShiftData id.
relationships
\nobject
Relationships for an on-call shift.
user
\nobject
Defines the relationship between a shift and the user who is working that shift.
data [required]
\nobject
Represents a reference to the user assigned to this shift, containing the user's ID and resource type.
id [required]
\nstring
Specifies the unique identifier of the user.
type [required]
\nenum
Indicates that the related resource is of type 'users'. \nAllowed enum values: users
default: users
type [required]
\nenum
Indicates that the resource is of type 'shifts'. \nAllowed enum values: shifts
default: shifts
Option 3
\nobject
Represents the primary data object for a schedule, linking attributes and relationships.
attributes
\nobject
Provides core properties of a schedule object such as its name and time zone.
name
\nstring
A short name for the schedule.
tags
\n[string]
A list of tags associated with the schedule.
time_zone
\nstring
The time zone in which this schedule operates.
id
\nstring
The schedule's unique identifier.
relationships
\nobject
Groups the relationships for a schedule object, referencing layers and teams.
layers
\nobject
Associates layers with this schedule in a data structure.
data
\n[object]
An array of layer references for this schedule.
id [required]
\nstring
The unique identifier of the layer in this relationship.
type [required]
\nenum
Layers resource type. \nAllowed enum values: layers
default: layers
teams
\nobject
Associates teams with this schedule in a data structure.
data
\n[object]
An array of team references for this schedule.
id [required]
\nstring
The unique identifier of the team in this relationship.
type [required]
\nenum
Teams resource type. \nAllowed enum values: teams
default: teams
type [required]
\nenum
Schedules resource type. \nAllowed enum values: schedules
default: schedules
Option 4
\nobject
User object returned by the API.
attributes
\nobject
Attributes of user object returned by the API.
created_at
\ndate-time
The ISO 8601 timestamp of when the user account was created.
disabled
\nboolean
Whether the user account is deactivated. Disabled users cannot log in.
string
The email address of the user, used for login and notifications.
handle
\nstring
The unique handle (username) of the user, typically matching their email prefix.
icon
\nstring
URL of the user's profile icon, typically a Gravatar URL derived from the email address.
last_login_time
\ndate-time
The ISO 8601 timestamp of the user's most recent login, or null if the user has never logged in.
mfa_enabled
\nboolean
Whether multi-factor authentication (MFA) is enabled for the user's account.
modified_at
\ndate-time
The ISO 8601 timestamp of when the user account was last modified.
name
\nstring
The full display name of the user as shown in the Datadog UI.
service_account
\nboolean
Whether this is a service account rather than a human user.\nService accounts are used for programmatic API access.
status
\nstring
The current status of the user account (for example, Active, Pending, or Disabled).
title
\nstring
The job title of the user (for example, "Senior Engineer" or "Product Manager").
uuid
\nstring
The globally unique identifier (UUID) of the user.
verified
\nboolean
Whether the user's email address has been verified.
id
\nstring
ID of the user.
relationships
\nobject
Relationships of the user object returned by the API.
org
\nobject
Relationship to an organization.
data [required]
\nobject
Relationship to organization object.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_orgs
\nobject
Relationship to organizations.
data [required]
\n[object]
Relationships to organization objects.
id [required]
\nstring
ID of the organization.
type [required]
\nenum
Organizations resource type. \nAllowed enum values: orgs
default: orgs
other_users
\nobject
Relationship to users.
data [required]
\n[object]
Relationships to user objects.
id [required]
\nstring
A unique identifier that represents the user.
type [required]
\nenum
Users resource type. \nAllowed enum values: users
default: users
roles
\nobject
Relationship to roles.
data
\n[object]
An array containing type and the unique identifier of a role.
id
\nstring
The unique identifier of the role.
type
\nenum
Roles type. \nAllowed enum values: roles
default: roles
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.