data
\n[object]
A list of monitor notification rules.
attributes
\nobject
Attributes of the monitor notification rule.
bundle_config
\nobject
Use bundle config to enable alert bundling to reduce monitor signal noises. Note: This feature is in preview and is subject to change.\nIf you have any feedback, contact Datadog support.
duration [required]
\nint32
Duration of the bundling period.
conditional_recipients
\nobject
Use conditional recipients to define different recipients for different situations. Cannot be used with recipients.
conditions [required]
\n[object]
Conditions of the notification rule.
recipients [required]
\n[string]
A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.
scope [required]
\nstring
Defines the condition under which the recipients are notified. Supported formats:
\ntransition_type:<status>, for example transition_type:is_alert.env:prod.fallback_recipients
\n[string]
If none of the conditions applied, fallback_recipients will get notified.
created
\ndate-time
Creation time of the monitor notification rule.
filter
\n<oneOf>
Specifies the matching criteria for monitor notifications.
Object 1
\nobject
Filters monitor notifications by a list of tag key:value pairs.
tags [required]
\n[string]
A list of tag key:value pairs (e.g. team:product). All tags must match (AND semantics).
Object 2
\nobject
Filters monitor notifications using a scope expression over key:value pairs with boolean logic (AND, OR, NOT).
scope [required]
\nstring
A scope expression composed by key:value pairs (e.g. service:foo) with boolean operators (AND, OR, NOT) and parentheses for grouping.
modified
\ndate-time
Time the monitor notification rule was last modified.
name
\nstring
The name of the monitor notification rule.
recipients
\n[string]
A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'. Cannot be used with conditional_recipients.
id
\nstring
The ID of the monitor notification rule.
relationships
\nobject
All relationships associated with monitor notification rule.
created_by
\nobject
The user who created the monitor notification rule.
data
\nobject
Data for the user who created the monitor notification rule.
id
\nstring
User ID of the monitor notification rule creator.
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
Monitor notification rule resource type. \nAllowed enum values: monitor-notification-rule
default: monitor-notification-rule
included
\n[ <oneOf>]
Array of objects related to the monitor notification rules.
<type=users>
\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
data
\n[object]
A list of monitor notification rules.
attributes
\nobject
Attributes of the monitor notification rule.
bundle_config
\nobject
Use bundle config to enable alert bundling to reduce monitor signal noises. Note: This feature is in preview and is subject to change.\nIf you have any feedback, contact Datadog support.
duration [required]
\nint32
Duration of the bundling period.
conditional_recipients
\nobject
Use conditional recipients to define different recipients for different situations. Cannot be used with recipients.
conditions [required]
\n[object]
Conditions of the notification rule.
recipients [required]
\n[string]
A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.
scope [required]
\nstring
Defines the condition under which the recipients are notified. Supported formats:
\ntransition_type:<status>, for example transition_type:is_alert.env:prod.fallback_recipients
\n[string]
If none of the conditions applied, fallback_recipients will get notified.
created
\ndate-time
Creation time of the monitor notification rule.
filter
\n<oneOf>
Specifies the matching criteria for monitor notifications.
Object 1
\nobject
Filters monitor notifications by a list of tag key:value pairs.
tags [required]
\n[string]
A list of tag key:value pairs (e.g. team:product). All tags must match (AND semantics).
Object 2
\nobject
Filters monitor notifications using a scope expression over key:value pairs with boolean logic (AND, OR, NOT).
scope [required]
\nstring
A scope expression composed by key:value pairs (e.g. service:foo) with boolean operators (AND, OR, NOT) and parentheses for grouping.
modified
\ndate-time
Time the monitor notification rule was last modified.
name
\nstring
The name of the monitor notification rule.
recipients
\n[string]
A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'. Cannot be used with conditional_recipients.
rule_options
\nobject
Additional options for the monitor notification rule.
is_threaded [required]
\nboolean
Whether notifications from this rule are threaded. When true, follow-up notifications for the same monitor alert are posted in Slack as replies to the first notification.\nCannot be true when bundle_config is set.
id
\nstring
The ID of the monitor notification rule.
relationships
\nobject
All relationships associated with monitor notification rule.
created_by
\nobject
The user who created the monitor notification rule.
data
\nobject
Data for the user who created the monitor notification rule.
id
\nstring
User ID of the monitor notification rule creator.
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
Monitor notification rule resource type. \nAllowed enum values: monitor-notification-rule
default: monitor-notification-rule
included
\n[ <oneOf>]
Array of objects related to the monitor notification rules.
<type=users>
\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
data
\nobject
Monitor notification rule data.
attributes
\nobject
Attributes of the monitor notification rule.
bundle_config
\nobject
Use bundle config to enable alert bundling to reduce monitor signal noises. Note: This feature is in preview and is subject to change.\nIf you have any feedback, contact Datadog support.
duration [required]
\nint32
Duration of the bundling period.
conditional_recipients
\nobject
Use conditional recipients to define different recipients for different situations. Cannot be used with recipients.
conditions [required]
\n[object]
Conditions of the notification rule.
recipients [required]
\n[string]
A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.
scope [required]
\nstring
Defines the condition under which the recipients are notified. Supported formats:
\ntransition_type:<status>, for example transition_type:is_alert.env:prod.fallback_recipients
\n[string]
If none of the conditions applied, fallback_recipients will get notified.
created
\ndate-time
Creation time of the monitor notification rule.
filter
\n<oneOf>
Specifies the matching criteria for monitor notifications.
Object 1
\nobject
Filters monitor notifications by a list of tag key:value pairs.
tags [required]
\n[string]
A list of tag key:value pairs (e.g. team:product). All tags must match (AND semantics).
Object 2
\nobject
Filters monitor notifications using a scope expression over key:value pairs with boolean logic (AND, OR, NOT).
scope [required]
\nstring
A scope expression composed by key:value pairs (e.g. service:foo) with boolean operators (AND, OR, NOT) and parentheses for grouping.
modified
\ndate-time
Time the monitor notification rule was last modified.
name
\nstring
The name of the monitor notification rule.
recipients
\n[string]
A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'. Cannot be used with conditional_recipients.
id
\nstring
The ID of the monitor notification rule.
relationships
\nobject
All relationships associated with monitor notification rule.
created_by
\nobject
The user who created the monitor notification rule.
data
\nobject
Data for the user who created the monitor notification rule.
id
\nstring
User ID of the monitor notification rule creator.
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
Monitor notification rule resource type. \nAllowed enum values: monitor-notification-rule
default: monitor-notification-rule
included
\n[ <oneOf>]
Array of objects related to the monitor notification rule that the user requested.
<type=users>
\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
data
\nobject
Monitor notification rule data.
attributes
\nobject
Attributes of the monitor notification rule.
bundle_config
\nobject
Use bundle config to enable alert bundling to reduce monitor signal noises. Note: This feature is in preview and is subject to change.\nIf you have any feedback, contact Datadog support.
duration [required]
\nint32
Duration of the bundling period.
conditional_recipients
\nobject
Use conditional recipients to define different recipients for different situations. Cannot be used with recipients.
conditions [required]
\n[object]
Conditions of the notification rule.
recipients [required]
\n[string]
A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.
scope [required]
\nstring
Defines the condition under which the recipients are notified. Supported formats:
\ntransition_type:<status>, for example transition_type:is_alert.env:prod.fallback_recipients
\n[string]
If none of the conditions applied, fallback_recipients will get notified.
created
\ndate-time
Creation time of the monitor notification rule.
filter
\n<oneOf>
Specifies the matching criteria for monitor notifications.
Object 1
\nobject
Filters monitor notifications by a list of tag key:value pairs.
tags [required]
\n[string]
A list of tag key:value pairs (e.g. team:product). All tags must match (AND semantics).
Object 2
\nobject
Filters monitor notifications using a scope expression over key:value pairs with boolean logic (AND, OR, NOT).
scope [required]
\nstring
A scope expression composed by key:value pairs (e.g. service:foo) with boolean operators (AND, OR, NOT) and parentheses for grouping.
modified
\ndate-time
Time the monitor notification rule was last modified.
name
\nstring
The name of the monitor notification rule.
recipients
\n[string]
A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'. Cannot be used with conditional_recipients.
rule_options
\nobject
Additional options for the monitor notification rule.
is_threaded [required]
\nboolean
Whether notifications from this rule are threaded. When true, follow-up notifications for the same monitor alert are posted in Slack as replies to the first notification.\nCannot be true when bundle_config is set.
id
\nstring
The ID of the monitor notification rule.
relationships
\nobject
All relationships associated with monitor notification rule.
created_by
\nobject
The user who created the monitor notification rule.
data
\nobject
Data for the user who created the monitor notification rule.
id
\nstring
User ID of the monitor notification rule creator.
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
Monitor notification rule resource type. \nAllowed enum values: monitor-notification-rule
default: monitor-notification-rule
included
\n[ <oneOf>]
Array of objects related to the monitor notification rule that the user requested.
<type=users>
\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
data [required]
\nobject
Object to create a monitor notification rule.
attributes [required]
\nobject
Attributes of the monitor notification rule.
bundle_config
\nobject
Use bundle config to enable alert bundling to reduce monitor signal noises. Note: This feature is in preview and is subject to change.\nIf you have any feedback, contact Datadog support.
duration [required]
\nint32
Duration of the bundling period.
conditional_recipients
\nobject
Use conditional recipients to define different recipients for different situations. Cannot be used with recipients.
conditions [required]
\n[object]
Conditions of the notification rule.
recipients [required]
\n[string]
A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.
scope [required]
\nstring
Defines the condition under which the recipients are notified. Supported formats:
\ntransition_type:<status>, for example transition_type:is_alert.env:prod.fallback_recipients
\n[string]
If none of the conditions applied, fallback_recipients will get notified.
filter
\n<oneOf>
Specifies the matching criteria for monitor notifications.
Object 1
\nobject
Filters monitor notifications by a list of tag key:value pairs.
tags [required]
\n[string]
A list of tag key:value pairs (e.g. team:product). All tags must match (AND semantics).
Object 2
\nobject
Filters monitor notifications using a scope expression over key:value pairs with boolean logic (AND, OR, NOT).
scope [required]
\nstring
A scope expression composed by key:value pairs (e.g. service:foo) with boolean operators (AND, OR, NOT) and parentheses for grouping.
name [required]
\nstring
The name of the monitor notification rule.
recipients
\n[string]
A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'. Cannot be used with conditional_recipients.
type
\nenum
Monitor notification rule resource type. \nAllowed enum values: monitor-notification-rule
default: monitor-notification-rule
data [required]
\nobject
Object to create a monitor notification rule.
attributes [required]
\nobject
Attributes of the monitor notification rule.
bundle_config
\nobject
Use bundle config to enable alert bundling to reduce monitor signal noises. Note: This feature is in preview and is subject to change.\nIf you have any feedback, contact Datadog support.
duration [required]
\nint32
Duration of the bundling period.
conditional_recipients
\nobject
Use conditional recipients to define different recipients for different situations. Cannot be used with recipients.
conditions [required]
\n[object]
Conditions of the notification rule.
recipients [required]
\n[string]
A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.
scope [required]
\nstring
Defines the condition under which the recipients are notified. Supported formats:
\ntransition_type:<status>, for example transition_type:is_alert.env:prod.fallback_recipients
\n[string]
If none of the conditions applied, fallback_recipients will get notified.
filter
\n<oneOf>
Specifies the matching criteria for monitor notifications.
Object 1
\nobject
Filters monitor notifications by a list of tag key:value pairs.
tags [required]
\n[string]
A list of tag key:value pairs (e.g. team:product). All tags must match (AND semantics).
Object 2
\nobject
Filters monitor notifications using a scope expression over key:value pairs with boolean logic (AND, OR, NOT).
scope [required]
\nstring
A scope expression composed by key:value pairs (e.g. service:foo) with boolean operators (AND, OR, NOT) and parentheses for grouping.
name [required]
\nstring
The name of the monitor notification rule.
recipients
\n[string]
A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'. Cannot be used with conditional_recipients.
rule_options
\nobject
Additional options for the monitor notification rule.
is_threaded [required]
\nboolean
Whether notifications from this rule are threaded. When true, follow-up notifications for the same monitor alert are posted in Slack as replies to the first notification.\nCannot be true when bundle_config is set.
type
\nenum
Monitor notification rule resource type. \nAllowed enum values: monitor-notification-rule
default: monitor-notification-rule
data
\nobject
Monitor notification rule data.
attributes
\nobject
Attributes of the monitor notification rule.
bundle_config
\nobject
Use bundle config to enable alert bundling to reduce monitor signal noises. Note: This feature is in preview and is subject to change.\nIf you have any feedback, contact Datadog support.
duration [required]
\nint32
Duration of the bundling period.
conditional_recipients
\nobject
Use conditional recipients to define different recipients for different situations. Cannot be used with recipients.
conditions [required]
\n[object]
Conditions of the notification rule.
recipients [required]
\n[string]
A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.
scope [required]
\nstring
Defines the condition under which the recipients are notified. Supported formats:
\ntransition_type:<status>, for example transition_type:is_alert.env:prod.fallback_recipients
\n[string]
If none of the conditions applied, fallback_recipients will get notified.
created
\ndate-time
Creation time of the monitor notification rule.
filter
\n<oneOf>
Specifies the matching criteria for monitor notifications.
Object 1
\nobject
Filters monitor notifications by a list of tag key:value pairs.
tags [required]
\n[string]
A list of tag key:value pairs (e.g. team:product). All tags must match (AND semantics).
Object 2
\nobject
Filters monitor notifications using a scope expression over key:value pairs with boolean logic (AND, OR, NOT).
scope [required]
\nstring
A scope expression composed by key:value pairs (e.g. service:foo) with boolean operators (AND, OR, NOT) and parentheses for grouping.
modified
\ndate-time
Time the monitor notification rule was last modified.
name
\nstring
The name of the monitor notification rule.
recipients
\n[string]
A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'. Cannot be used with conditional_recipients.
id
\nstring
The ID of the monitor notification rule.
relationships
\nobject
All relationships associated with monitor notification rule.
created_by
\nobject
The user who created the monitor notification rule.
data
\nobject
Data for the user who created the monitor notification rule.
id
\nstring
User ID of the monitor notification rule creator.
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
Monitor notification rule resource type. \nAllowed enum values: monitor-notification-rule
default: monitor-notification-rule
included
\n[ <oneOf>]
Array of objects related to the monitor notification rule that the user requested.
<type=users>
\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
data
\nobject
Monitor notification rule data.
attributes
\nobject
Attributes of the monitor notification rule.
bundle_config
\nobject
Use bundle config to enable alert bundling to reduce monitor signal noises. Note: This feature is in preview and is subject to change.\nIf you have any feedback, contact Datadog support.
duration [required]
\nint32
Duration of the bundling period.
conditional_recipients
\nobject
Use conditional recipients to define different recipients for different situations. Cannot be used with recipients.
conditions [required]
\n[object]
Conditions of the notification rule.
recipients [required]
\n[string]
A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.
scope [required]
\nstring
Defines the condition under which the recipients are notified. Supported formats:
\ntransition_type:<status>, for example transition_type:is_alert.env:prod.fallback_recipients
\n[string]
If none of the conditions applied, fallback_recipients will get notified.
created
\ndate-time
Creation time of the monitor notification rule.
filter
\n<oneOf>
Specifies the matching criteria for monitor notifications.
Object 1
\nobject
Filters monitor notifications by a list of tag key:value pairs.
tags [required]
\n[string]
A list of tag key:value pairs (e.g. team:product). All tags must match (AND semantics).
Object 2
\nobject
Filters monitor notifications using a scope expression over key:value pairs with boolean logic (AND, OR, NOT).
scope [required]
\nstring
A scope expression composed by key:value pairs (e.g. service:foo) with boolean operators (AND, OR, NOT) and parentheses for grouping.
modified
\ndate-time
Time the monitor notification rule was last modified.
name
\nstring
The name of the monitor notification rule.
recipients
\n[string]
A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'. Cannot be used with conditional_recipients.
rule_options
\nobject
Additional options for the monitor notification rule.
is_threaded [required]
\nboolean
Whether notifications from this rule are threaded. When true, follow-up notifications for the same monitor alert are posted in Slack as replies to the first notification.\nCannot be true when bundle_config is set.
id
\nstring
The ID of the monitor notification rule.
relationships
\nobject
All relationships associated with monitor notification rule.
created_by
\nobject
The user who created the monitor notification rule.
data
\nobject
Data for the user who created the monitor notification rule.
id
\nstring
User ID of the monitor notification rule creator.
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
Monitor notification rule resource type. \nAllowed enum values: monitor-notification-rule
default: monitor-notification-rule
included
\n[ <oneOf>]
Array of objects related to the monitor notification rule that the user requested.
<type=users>
\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
data
\nobject
Monitor notification rule data.
attributes
\nobject
Attributes of the monitor notification rule.
bundle_config
\nobject
Use bundle config to enable alert bundling to reduce monitor signal noises. Note: This feature is in preview and is subject to change.\nIf you have any feedback, contact Datadog support.
duration [required]
\nint32
Duration of the bundling period.
conditional_recipients
\nobject
Use conditional recipients to define different recipients for different situations. Cannot be used with recipients.
conditions [required]
\n[object]
Conditions of the notification rule.
recipients [required]
\n[string]
A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.
scope [required]
\nstring
Defines the condition under which the recipients are notified. Supported formats:
\ntransition_type:<status>, for example transition_type:is_alert.env:prod.fallback_recipients
\n[string]
If none of the conditions applied, fallback_recipients will get notified.
created
\ndate-time
Creation time of the monitor notification rule.
filter
\n<oneOf>
Specifies the matching criteria for monitor notifications.
Object 1
\nobject
Filters monitor notifications by a list of tag key:value pairs.
tags [required]
\n[string]
A list of tag key:value pairs (e.g. team:product). All tags must match (AND semantics).
Object 2
\nobject
Filters monitor notifications using a scope expression over key:value pairs with boolean logic (AND, OR, NOT).
scope [required]
\nstring
A scope expression composed by key:value pairs (e.g. service:foo) with boolean operators (AND, OR, NOT) and parentheses for grouping.
modified
\ndate-time
Time the monitor notification rule was last modified.
name
\nstring
The name of the monitor notification rule.
recipients
\n[string]
A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'. Cannot be used with conditional_recipients.
id
\nstring
The ID of the monitor notification rule.
relationships
\nobject
All relationships associated with monitor notification rule.
created_by
\nobject
The user who created the monitor notification rule.
data
\nobject
Data for the user who created the monitor notification rule.
id
\nstring
User ID of the monitor notification rule creator.
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
Monitor notification rule resource type. \nAllowed enum values: monitor-notification-rule
default: monitor-notification-rule
included
\n[ <oneOf>]
Array of objects related to the monitor notification rule that the user requested.
<type=users>
\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
data
\nobject
Monitor notification rule data.
attributes
\nobject
Attributes of the monitor notification rule.
bundle_config
\nobject
Use bundle config to enable alert bundling to reduce monitor signal noises. Note: This feature is in preview and is subject to change.\nIf you have any feedback, contact Datadog support.
duration [required]
\nint32
Duration of the bundling period.
conditional_recipients
\nobject
Use conditional recipients to define different recipients for different situations. Cannot be used with recipients.
conditions [required]
\n[object]
Conditions of the notification rule.
recipients [required]
\n[string]
A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.
scope [required]
\nstring
Defines the condition under which the recipients are notified. Supported formats:
\ntransition_type:<status>, for example transition_type:is_alert.env:prod.fallback_recipients
\n[string]
If none of the conditions applied, fallback_recipients will get notified.
created
\ndate-time
Creation time of the monitor notification rule.
filter
\n<oneOf>
Specifies the matching criteria for monitor notifications.
Object 1
\nobject
Filters monitor notifications by a list of tag key:value pairs.
tags [required]
\n[string]
A list of tag key:value pairs (e.g. team:product). All tags must match (AND semantics).
Object 2
\nobject
Filters monitor notifications using a scope expression over key:value pairs with boolean logic (AND, OR, NOT).
scope [required]
\nstring
A scope expression composed by key:value pairs (e.g. service:foo) with boolean operators (AND, OR, NOT) and parentheses for grouping.
modified
\ndate-time
Time the monitor notification rule was last modified.
name
\nstring
The name of the monitor notification rule.
recipients
\n[string]
A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'. Cannot be used with conditional_recipients.
rule_options
\nobject
Additional options for the monitor notification rule.
is_threaded [required]
\nboolean
Whether notifications from this rule are threaded. When true, follow-up notifications for the same monitor alert are posted in Slack as replies to the first notification.\nCannot be true when bundle_config is set.
id
\nstring
The ID of the monitor notification rule.
relationships
\nobject
All relationships associated with monitor notification rule.
created_by
\nobject
The user who created the monitor notification rule.
data
\nobject
Data for the user who created the monitor notification rule.
id
\nstring
User ID of the monitor notification rule creator.
type
\nenum
Users resource type. \nAllowed enum values: users
default: users
type
\nenum
Monitor notification rule resource type. \nAllowed enum values: monitor-notification-rule
default: monitor-notification-rule
included
\n[ <oneOf>]
Array of objects related to the monitor notification rule that the user requested.
<type=users>
\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
data [required]
\nobject
Object to update a monitor notification rule.
attributes [required]
\nobject
Attributes of the monitor notification rule.
bundle_config
\nobject
Use bundle config to enable alert bundling to reduce monitor signal noises. Note: This feature is in preview and is subject to change.\nIf you have any feedback, contact Datadog support.
duration [required]
\nint32
Duration of the bundling period.
conditional_recipients
\nobject
Use conditional recipients to define different recipients for different situations. Cannot be used with recipients.
conditions [required]
\n[object]
Conditions of the notification rule.
recipients [required]
\n[string]
A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.
scope [required]
\nstring
Defines the condition under which the recipients are notified. Supported formats:
\ntransition_type:<status>, for example transition_type:is_alert.env:prod.fallback_recipients
\n[string]
If none of the conditions applied, fallback_recipients will get notified.
filter
\n<oneOf>
Specifies the matching criteria for monitor notifications.
Object 1
\nobject
Filters monitor notifications by a list of tag key:value pairs.
tags [required]
\n[string]
A list of tag key:value pairs (e.g. team:product). All tags must match (AND semantics).
Object 2
\nobject
Filters monitor notifications using a scope expression over key:value pairs with boolean logic (AND, OR, NOT).
scope [required]
\nstring
A scope expression composed by key:value pairs (e.g. service:foo) with boolean operators (AND, OR, NOT) and parentheses for grouping.
name [required]
\nstring
The name of the monitor notification rule.
recipients
\n[string]
A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'. Cannot be used with conditional_recipients.
id [required]
\nstring
The ID of the monitor notification rule.
type
\nenum
Monitor notification rule resource type. \nAllowed enum values: monitor-notification-rule
default: monitor-notification-rule
data [required]
\nobject
Object to update a monitor notification rule.
attributes [required]
\nobject
Attributes of the monitor notification rule.
bundle_config
\nobject
Use bundle config to enable alert bundling to reduce monitor signal noises. Note: This feature is in preview and is subject to change.\nIf you have any feedback, contact Datadog support.
duration [required]
\nint32
Duration of the bundling period.
conditional_recipients
\nobject
Use conditional recipients to define different recipients for different situations. Cannot be used with recipients.
conditions [required]
\n[object]
Conditions of the notification rule.
recipients [required]
\n[string]
A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'.
scope [required]
\nstring
Defines the condition under which the recipients are notified. Supported formats:
\ntransition_type:<status>, for example transition_type:is_alert.env:prod.fallback_recipients
\n[string]
If none of the conditions applied, fallback_recipients will get notified.
filter
\n<oneOf>
Specifies the matching criteria for monitor notifications.
Object 1
\nobject
Filters monitor notifications by a list of tag key:value pairs.
tags [required]
\n[string]
A list of tag key:value pairs (e.g. team:product). All tags must match (AND semantics).
Object 2
\nobject
Filters monitor notifications using a scope expression over key:value pairs with boolean logic (AND, OR, NOT).
scope [required]
\nstring
A scope expression composed by key:value pairs (e.g. service:foo) with boolean operators (AND, OR, NOT) and parentheses for grouping.
name [required]
\nstring
The name of the monitor notification rule.
recipients
\n[string]
A list of recipients to notify. Uses the same format as the monitor message field. Must not start with an '@'. Cannot be used with conditional_recipients.
rule_options
\nobject
Additional options for the monitor notification rule.
is_threaded [required]
\nboolean
Whether notifications from this rule are threaded. When true, follow-up notifications for the same monitor alert are posted in Slack as replies to the first notification.\nCannot be true when bundle_config is set.
id [required]
\nstring
The ID of the monitor notification rule.
type
\nenum
Monitor notification rule resource type. \nAllowed enum values: monitor-notification-rule
default: monitor-notification-rule