datadog_api_client.v1.model¶

access_role¶

class AccessRole(*args, **kwargs)¶

Bases: ModelSimple

The access role of the user. Options are st (standard user), adm (admin user), or ro (read-only user).

Parameters:

value (str) – If omitted defaults to “st”. Must be one of [“st”, “adm”, “ro”, “ERROR”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

add_signal_to_incident_request¶

class AddSignalToIncidentRequest(*args, **kwargs)¶

Bases: ModelNormal

Attributes describing which incident to add the signal to.

Parameters:

add_to_signal_timeline (bool, optional) – Whether to post the signal on the incident timeline.
incident_id (int) – Public ID attribute of the incident to which the signal will be added.
version (int, optional) – Version of the updated signal. If server side version is higher, update will be rejected.

agent_check¶

class AgentCheck(*args, **kwargs)¶

Bases: ModelSimple

Array of strings.

Parameters:

_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

alert_graph_widget_definition¶

class AlertGraphWidgetDefinition(*args, **kwargs)¶

Bases: ModelNormal

Alert graphs are timeseries graphs showing the current status of any monitor defined on your system.

Parameters:

alert_id (str) – ID of the alert to use in the widget.
time (WidgetTime, optional) – Time setting for the widget.
title (str, optional) – The title of the widget.
title_align (WidgetTextAlign, optional) – How to align the text on the widget.
title_size (str, optional) – Size of the title.
type (AlertGraphWidgetDefinitionType) – Type of the alert graph widget.
viz_type (WidgetVizType) – Whether to display the Alert Graph as a timeseries or a top list.

alert_graph_widget_definition_type¶

class AlertGraphWidgetDefinitionType(*args, **kwargs)¶

Bases: ModelSimple

Type of the alert graph widget.

Parameters:

value (str) – If omitted defaults to “alert_graph”. Must be one of [“alert_graph”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

alert_value_widget_definition¶

class AlertValueWidgetDefinition(*args, **kwargs)¶

Bases: ModelNormal

Alert values are query values showing the current value of the metric in any monitor defined on your system.

Parameters:

alert_id (str) – ID of the alert to use in the widget.
precision (int, optional) – Number of decimal to show. If not defined, will use the raw value.
text_align (WidgetTextAlign, optional) – How to align the text on the widget.
title (str, optional) – Title of the widget.
title_align (WidgetTextAlign, optional) – How to align the text on the widget.
title_size (str, optional) – Size of value in the widget.
type (AlertValueWidgetDefinitionType) – Type of the alert value widget.
unit (str, optional) – Unit to display with the value.

alert_value_widget_definition_type¶

class AlertValueWidgetDefinitionType(*args, **kwargs)¶

Bases: ModelSimple

Type of the alert value widget.

Parameters:

value (str) – If omitted defaults to “alert_value”. Must be one of [“alert_value”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

api_error_response¶

class APIErrorResponse(*args, **kwargs)¶

Bases: ModelNormal

Error response object.

Parameters:: errors ([str]) – Array of errors returned by the API.

api_key¶

class ApiKey(*args, **kwargs)¶

Bases: ModelNormal

Datadog API key.

Parameters:

created (str, optional) – Date of creation of the API key.
created_by (str, optional) – Datadog user handle that created the API key.
key (str, optional) – API key.
name (str, optional) – Name of your API key.

api_key_list_response¶

class ApiKeyListResponse(*args, **kwargs)¶

Bases: ModelNormal

List of API and application keys available for a given organization.

Parameters:: api_keys ([ApiKey], optional) – Array of API keys.

api_key_response¶

class ApiKeyResponse(*args, **kwargs)¶

Bases: ModelNormal

An API key with its associated metadata.

Parameters:: api_key (ApiKey, optional) – Datadog API key.

apm_stats_query_column_type¶

class ApmStatsQueryColumnType(*args, **kwargs)¶

Bases: ModelNormal

Column properties.

Parameters:

alias (str, optional) – A user-assigned alias for the column.
cell_display_mode (TableWidgetCellDisplayMode, optional) – Define a display mode for the table cell.
name (str) – Column name.
order (WidgetSort, optional) – Widget sorting methods.

apm_stats_query_definition¶

class ApmStatsQueryDefinition(*args, **kwargs)¶

Bases: ModelNormal

The APM stats query for table and distributions widgets.

Parameters:

columns ([ApmStatsQueryColumnType], optional) – Column properties used by the front end for display.
env (str) – Environment name.
name (str) – Operation name associated with service.
primary_tag (str) – The organization’s host group name and value.
resource (str, optional) – Resource name.
row_type (ApmStatsQueryRowType) – The level of detail for the request.
service (str) – Service name.

apm_stats_query_row_type¶

class ApmStatsQueryRowType(*args, **kwargs)¶

Bases: ModelSimple

The level of detail for the request.

Parameters:

value (str) – Must be one of [“service”, “resource”, “span”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

application_key¶

class ApplicationKey(*args, **kwargs)¶

Bases: ModelNormal

An application key with its associated metadata.

Parameters:

hash (str, optional) – Hash of an application key.
name (str, optional) – Name of an application key.
owner (str, optional) – Owner of an application key.

application_key_list_response¶

class ApplicationKeyListResponse(*args, **kwargs)¶

Bases: ModelNormal

An application key response.

Parameters:: application_keys ([ApplicationKey], optional) – Array of application keys.

application_key_response¶

class ApplicationKeyResponse(*args, **kwargs)¶

Bases: ModelNormal

An application key response.

Parameters:: application_key (ApplicationKey, optional) – An application key with its associated metadata.

authentication_validation_response¶

class AuthenticationValidationResponse(*args, **kwargs)¶

Bases: ModelNormal

Represent validation endpoint responses.

Parameters:: valid (bool, optional) – Return true if the authentication response is valid.

aws_account¶

class AWSAccount(*args, **kwargs)¶

Bases: ModelNormal

Returns the AWS account associated with this integration.

Parameters:

access_key_id (str, optional) – Your AWS access key ID. Only required if your AWS account is a GovCloud or China account.
account_id (str, optional) – Your AWS Account ID without dashes.
account_specific_namespace_rules ({str: (bool,)}, optional) – An object, (in the form {"namespace1":true/false, "namespace2":true/false} ), that enables or disables metric collection for specific AWS namespaces for this AWS account only.
cspm_resource_collection_enabled (bool, optional) – Whether Datadog collects cloud security posture management resources from your AWS account. This includes additional resources not covered under the general resource_collection.
excluded_regions ([str], optional) – An array of AWS regions to exclude from metrics collection.
filter_tags ([str], optional) – The array of EC2 tags (in the form key:value ) defines a filter that Datadog uses when collecting metrics from EC2. Wildcards, such as ? (for single characters) and * (for multiple characters) can also be used. Only hosts that match one of the defined tags will be imported into Datadog. The rest will be ignored. Host matching a given tag can also be excluded by adding ! before the tag. For example, env:production,instance-type:c1.*,!region:us-east-1
host_tags ([str], optional) – Array of tags (in the form key:value ) to add to all hosts and metrics reporting through this integration.
metrics_collection_enabled (bool, optional) – Whether Datadog collects metrics for this AWS account.
resource_collection_enabled (bool, optional) – Whether Datadog collects a standard set of resources from your AWS account.
role_name (str, optional) – Your Datadog role delegation name.
secret_access_key (str, optional) – Your AWS secret access key. Only required if your AWS account is a GovCloud or China account.

aws_account_and_lambda_request¶

class AWSAccountAndLambdaRequest(*args, **kwargs)¶

Bases: ModelNormal

AWS account ID and Lambda ARN.

Parameters:

account_id (str) – Your AWS Account ID without dashes.
lambda_arn (str) – ARN of the Datadog Lambda created during the Datadog-Amazon Web services Log collection setup.

aws_account_create_response¶

class AWSAccountCreateResponse(*args, **kwargs)¶

Bases: ModelNormal

The Response returned by the AWS Create Account call.

Parameters:: external_id (str, optional) – AWS external_id.

aws_account_delete_request¶

class AWSAccountDeleteRequest(*args, **kwargs)¶

Bases: ModelNormal

List of AWS accounts to delete.

Parameters:

access_key_id (str, optional) – Your AWS access key ID. Only required if your AWS account is a GovCloud or China account.
account_id (str, optional) – Your AWS Account ID without dashes.
role_name (str, optional) – Your Datadog role delegation name.

aws_account_list_response¶

class AWSAccountListResponse(*args, **kwargs)¶

Bases: ModelNormal

List of enabled AWS accounts.

Parameters:: accounts ([AWSAccount], optional) – List of enabled AWS accounts.

aws_logs_async_error¶

class AWSLogsAsyncError(*args, **kwargs)¶

Bases: ModelNormal

Description of errors.

Parameters:

code (str, optional) – Code properties
message (str, optional) – Message content.

aws_logs_async_response¶

class AWSLogsAsyncResponse(*args, **kwargs)¶

Bases: ModelNormal

A list of all Datadog-AWS logs integrations available in your Datadog organization.

Parameters:

errors ([AWSLogsAsyncError], optional) – List of errors.
status (str, optional) – Status of the properties.

aws_logs_lambda¶

class AWSLogsLambda(*args, **kwargs)¶

Bases: ModelNormal

Description of the Lambdas.

Parameters:: arn (str, optional) – Available ARN IDs.

aws_logs_list_response¶

class AWSLogsListResponse(*args, **kwargs)¶

Bases: ModelNormal

A list of all Datadog-AWS logs integrations available in your Datadog organization.

Parameters:

account_id (str, optional) – Your AWS Account ID without dashes.
lambdas ([AWSLogsLambda], optional) – List of ARNs configured in your Datadog account.
services ([str], optional) – Array of services IDs.

aws_logs_list_services_response¶

class AWSLogsListServicesResponse(*args, **kwargs)¶

Bases: ModelNormal

The list of current AWS services for which Datadog offers automatic log collection.

Parameters:

id (str, optional) – Key value in returned object.
label (str, optional) – Name of service available for configuration with Datadog logs.

aws_logs_services_request¶

class AWSLogsServicesRequest(*args, **kwargs)¶

Bases: ModelNormal

A list of current AWS services for which Datadog offers automatic log collection.

Parameters:

account_id (str) – Your AWS Account ID without dashes.
services ([str]) – Array of services IDs set to enable automatic log collection. Discover the list of available services with the get list of AWS log ready services API endpoint.

aws_namespace¶

class AWSNamespace(*args, **kwargs)¶

Bases: ModelSimple

The namespace associated with the tag filter entry.

Parameters:

value (str) – Must be one of [“elb”, “application_elb”, “sqs”, “rds”, “custom”, “network_elb”, “lambda”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

aws_tag_filter¶

class AWSTagFilter(*args, **kwargs)¶

Bases: ModelNormal

A tag filter.

Parameters:

namespace (AWSNamespace, optional) – The namespace associated with the tag filter entry.
tag_filter_str (str, optional) – The tag filter string.

aws_tag_filter_create_request¶

class AWSTagFilterCreateRequest(*args, **kwargs)¶

Bases: ModelNormal

The objects used to set an AWS tag filter.

Parameters:

account_id (str, optional) – Your AWS Account ID without dashes.
namespace (AWSNamespace, optional) – The namespace associated with the tag filter entry.
tag_filter_str (str, optional) – The tag filter string.

aws_tag_filter_delete_request¶

class AWSTagFilterDeleteRequest(*args, **kwargs)¶

Bases: ModelNormal

The objects used to delete an AWS tag filter entry.

Parameters:

account_id (str, optional) – The unique identifier of your AWS account.
namespace (AWSNamespace, optional) – The namespace associated with the tag filter entry.

aws_tag_filter_list_response¶

class AWSTagFilterListResponse(*args, **kwargs)¶

Bases: ModelNormal

An array of tag filter rules by namespace and tag filter string.

Parameters:: filters ([AWSTagFilter], optional) – An array of tag filters.

azure_account¶

class AzureAccount(*args, **kwargs)¶

Bases: ModelNormal

Datadog-Azure integrations configured for your organization.

Parameters:

automute (bool, optional) – Silence monitors for expected Azure VM shutdowns.
client_id (str, optional) – Your Azure web application ID.
client_secret (str, optional) – Your Azure web application secret key.
errors ([str], optional) – Errors in your configuration.
host_filters (str, optional) – Limit the Azure instances that are pulled into Datadog by using tags. Only hosts that match one of the defined tags are imported into Datadog.
new_client_id (str, optional) – Your New Azure web application ID.
new_tenant_name (str, optional) – Your New Azure Active Directory ID.
tenant_name (str, optional) – Your Azure Active Directory ID.

azure_account_list_response¶

class AzureAccountListResponse(*args, **kwargs)¶

Bases: ModelSimple

Accounts configured for your organization.

Parameters:

_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

cancel_downtimes_by_scope_request¶

class CancelDowntimesByScopeRequest(*args, **kwargs)¶

Bases: ModelNormal

Cancel downtimes according to scope.

Parameters:: scope (str) – The scope(s) to which the downtime applies and must be in key:value format. For example, host:app2. Provide multiple scopes as a comma-separated list like env:dev,env:prod. The resulting downtime applies to sources that matches ALL provided scopes ( env:dev AND env:prod ).

canceled_downtimes_ids¶

class CanceledDowntimesIds(*args, **kwargs)¶

Bases: ModelNormal

Object containing array of IDs of canceled downtimes.

Parameters:: cancelled_ids ([int], optional) – ID of downtimes that were canceled.

change_widget_definition¶

class ChangeWidgetDefinition(*args, **kwargs)¶

Bases: ModelNormal

The Change graph shows you the change in a value over the time period chosen.

Parameters:

custom_links ([WidgetCustomLink], optional) – List of custom links.
requests ([ChangeWidgetRequest]) –
Array of one request object to display in the widget.

See the dedicated Request JSON schema documentation
to learn how to build the REQUEST_SCHEMA.
time (WidgetTime, optional) – Time setting for the widget.
title (str, optional) – Title of the widget.
title_align (WidgetTextAlign, optional) – How to align the text on the widget.
title_size (str, optional) – Size of the title.
type (ChangeWidgetDefinitionType) – Type of the change widget.

change_widget_definition_type¶

class ChangeWidgetDefinitionType(*args, **kwargs)¶

Bases: ModelSimple

Type of the change widget.

Parameters:

value (str) – If omitted defaults to “change”. Must be one of [“change”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

change_widget_request¶

class ChangeWidgetRequest(*args, **kwargs)¶

Bases: ModelNormal

Updated change widget.

Parameters:

apm_query (LogQueryDefinition, optional) – The log query.
change_type (WidgetChangeType, optional) – Show the absolute or the relative change.
compare_to (WidgetCompareTo, optional) – Timeframe used for the change comparison.
event_query (LogQueryDefinition, optional) – The log query.
formulas ([WidgetFormula], optional) – List of formulas that operate on queries.
increase_good (bool, optional) – Whether to show increase as good.
log_query (LogQueryDefinition, optional) – The log query.
network_query (LogQueryDefinition, optional) – The log query.
order_by (WidgetOrderBy, optional) – What to order by.
order_dir (WidgetSort, optional) – Widget sorting methods.
process_query (ProcessQueryDefinition, optional) – The process query to use in the widget.
profile_metrics_query (LogQueryDefinition, optional) – The log query.
q (str, optional) – Query definition.
queries ([FormulaAndFunctionQueryDefinition], optional) – List of queries that can be returned directly or used in formulas.
response_format (FormulaAndFunctionResponseFormat, optional) – Timeseries or Scalar response.
rum_query (LogQueryDefinition, optional) – The log query.
security_query (LogQueryDefinition, optional) – The log query.
show_present (bool, optional) – Whether to show the present value.

check_can_delete_monitor_response¶

class CheckCanDeleteMonitorResponse(*args, **kwargs)¶

Bases: ModelNormal

Response of monitor IDs that can or can’t be safely deleted.

Parameters:

data (CheckCanDeleteMonitorResponseData) – Wrapper object with the list of monitor IDs.
errors ({str: ([str],)}, none_type, optional) – A mapping of Monitor ID to strings denoting where it’s used.

check_can_delete_monitor_response_data¶

class CheckCanDeleteMonitorResponseData(*args, **kwargs)¶

Bases: ModelNormal

Wrapper object with the list of monitor IDs.

Parameters:: ok ([int], optional) – An array of of Monitor IDs that can be safely deleted.

check_can_delete_slo_response¶

class CheckCanDeleteSLOResponse(*args, **kwargs)¶

Bases: ModelNormal

A service level objective response containing the requested object.

Parameters:

data (CheckCanDeleteSLOResponseData, optional) – An array of service level objective objects.
errors ({str: (str,)}, optional) – A mapping of SLO id to it’s current usages.

check_can_delete_slo_response_data¶

class CheckCanDeleteSLOResponseData(*args, **kwargs)¶

Bases: ModelNormal

An array of service level objective objects.

Parameters:: ok ([str], optional) – An array of of SLO IDs that can be safely deleted.

check_status_widget_definition¶

class CheckStatusWidgetDefinition(*args, **kwargs)¶

Bases: ModelNormal

Check status shows the current status or number of results for any check performed.

Parameters:

check (str) – Name of the check to use in the widget.
group (str, optional) – Group reporting a single check.
group_by ([str], optional) – List of tag prefixes to group by in the case of a cluster check.
grouping (WidgetGrouping) – The kind of grouping to use.
tags ([str], optional) – List of tags used to filter the groups reporting a cluster check.
time (WidgetTime, optional) – Time setting for the widget.
title (str, optional) – Title of the widget.
title_align (WidgetTextAlign, optional) – How to align the text on the widget.
title_size (str, optional) – Size of the title.
type (CheckStatusWidgetDefinitionType) – Type of the check status widget.

check_status_widget_definition_type¶

class CheckStatusWidgetDefinitionType(*args, **kwargs)¶

Bases: ModelSimple

Type of the check status widget.

Parameters:

value (str) – If omitted defaults to “check_status”. Must be one of [“check_status”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

content_encoding¶

class ContentEncoding(*args, **kwargs)¶

Bases: ModelSimple

HTTP header used to compress the media-type.

Parameters:

value (str) – Must be one of [“gzip”, “deflate”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

creator¶

class Creator(*args, **kwargs)¶

Bases: ModelNormal

Object describing the creator of the shared element.

Parameters:

email (str, optional) – Email of the creator.
handle (str, optional) – Handle of the creator.
name (str, none_type, optional) – Name of the creator.

dashboard¶

class Dashboard(*args, **kwargs)¶

Bases: ModelNormal

A dashboard is Datadog’s tool for visually tracking, analyzing, and displaying key performance metrics, which enable you to monitor the health of your infrastructure.

Parameters:

author_handle (str, optional) – Identifier of the dashboard author.
author_name (str, none_type, optional) – Name of the dashboard author.
created_at (datetime, optional) – Creation date of the dashboard.
description (str, none_type, optional) – Description of the dashboard.
id (str, optional) – ID of the dashboard.
is_read_only (bool, optional) – Whether this dashboard is read-only. If True, only the author and admins can make changes to it. Prefer using restricted_roles to manage write authorization. Deprecated.
layout_type (DashboardLayoutType) – Layout type of the dashboard.
modified_at (datetime, optional) – Modification date of the dashboard.
notify_list ([str], none_type, optional) – List of handles of users to notify when changes are made to this dashboard.
reflow_type (DashboardReflowType, optional) – Reflow type for a new dashboard layout dashboard. Set this only when layout type is ‘ordered’. If set to ‘fixed’, the dashboard expects all widgets to have a layout, and if it’s set to ‘auto’, widgets should not have layouts.
restricted_roles ([str], optional) – A list of role identifiers. Only the author and users associated with at least one of these roles can edit this dashboard.
tags ([str], none_type, optional) – List of team names representing ownership of a dashboard.
template_variable_presets ([DashboardTemplateVariablePreset], none_type, optional) – Array of template variables saved views.
template_variables ([DashboardTemplateVariable], none_type, optional) – List of template variables for this dashboard.
title (str) – Title of the dashboard.
url (str, optional) – The URL of the dashboard.
widgets ([Widget]) – List of widgets to display on the dashboard.

dashboard_bulk_action_data¶

class DashboardBulkActionData(*args, **kwargs)¶

Bases: ModelNormal

Dashboard bulk action request data.

Parameters:

id (str) – Dashboard resource ID.
type (DashboardResourceType) – Dashboard resource type.

dashboard_bulk_action_data_list¶

class DashboardBulkActionDataList(*args, **kwargs)¶

Bases: ModelSimple

List of dashboard bulk action request data objects.

Parameters:

_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

dashboard_bulk_delete_request¶

class DashboardBulkDeleteRequest(*args, **kwargs)¶

Bases: ModelNormal

Dashboard bulk delete request body.

Parameters:: data (DashboardBulkActionDataList) – List of dashboard bulk action request data objects.

dashboard_delete_response¶

class DashboardDeleteResponse(*args, **kwargs)¶

Bases: ModelNormal

Response from the delete dashboard call.

Parameters:: deleted_dashboard_id (str, optional) – ID of the deleted dashboard.

dashboard_global_time¶

class DashboardGlobalTime(*args, **kwargs)¶

Bases: ModelNormal

Object containing the live span selection for the dashboard.

Parameters:: live_span (DashboardGlobalTimeLiveSpan, optional) – Dashboard global time live_span selection

dashboard_global_time_live_span¶

class DashboardGlobalTimeLiveSpan(*args, **kwargs)¶

Bases: ModelSimple

Dashboard global time live_span selection

Parameters:

value (str) – Must be one of [“15m”, “1h”, “4h”, “1d”, “2d”, “1w”, “1mo”, “3mo”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

dashboard_invite_type¶

class DashboardInviteType(*args, **kwargs)¶

Bases: ModelSimple

Type for shared dashboard invitation request body.

Parameters:

value (str) – If omitted defaults to “public_dashboard_invitation”. Must be one of [“public_dashboard_invitation”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

dashboard_layout_type¶

class DashboardLayoutType(*args, **kwargs)¶

Bases: ModelSimple

Layout type of the dashboard.

Parameters:

value (str) – Must be one of [“ordered”, “free”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

dashboard_list¶

class DashboardList(*args, **kwargs)¶

Bases: ModelNormal

Your Datadog Dashboards.

Parameters:

author (Creator, optional) – Object describing the creator of the shared element.
created (datetime, optional) – Date of creation of the dashboard list.
dashboard_count (int, optional) – The number of dashboards in the list.
id (int, optional) – The ID of the dashboard list.
is_favorite (bool, optional) – Whether or not the list is in the favorites.
modified (datetime, optional) – Date of last edition of the dashboard list.
name (str) – The name of the dashboard list.
type (str, optional) – The type of dashboard list.

dashboard_list_delete_response¶

class DashboardListDeleteResponse(*args, **kwargs)¶

Bases: ModelNormal

Deleted dashboard details.

Parameters:: deleted_dashboard_list_id (int, optional) – ID of the deleted dashboard list.

dashboard_list_list_response¶

class DashboardListListResponse(*args, **kwargs)¶

Bases: ModelNormal

Information on your dashboard lists.

Parameters:: dashboard_lists ([DashboardList], optional) – List of all your dashboard lists.

dashboard_reflow_type¶

class DashboardReflowType(*args, **kwargs)¶

Bases: ModelSimple

Reflow type for a new dashboard layout dashboard. Set this only when layout type is ‘ordered’.: If set to ‘fixed’, the dashboard expects all widgets to have a layout, and if it’s set to ‘auto’, widgets should not have layouts.

Parameters:

value (str) – Must be one of [“auto”, “fixed”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

dashboard_resource_type¶

class DashboardResourceType(*args, **kwargs)¶

Bases: ModelSimple

Dashboard resource type.

Parameters:

value (str) – If omitted defaults to “dashboard”. Must be one of [“dashboard”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

dashboard_restore_request¶

class DashboardRestoreRequest(*args, **kwargs)¶

Bases: ModelNormal

Dashboard restore request body.

Parameters:: data (DashboardBulkActionDataList) – List of dashboard bulk action request data objects.

dashboard_share_type¶

class DashboardShareType(*args, **kwargs)¶

Bases: ModelSimple

Type of sharing access (either open to anyone who has the public URL or invite-only).

Parameters:

value (str) – Must be one of [“open”, “invite”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

dashboard_summary¶

class DashboardSummary(*args, **kwargs)¶

Bases: ModelNormal

Dashboard summary response.

Parameters:: dashboards ([DashboardSummaryDefinition], optional) – List of dashboard definitions.

dashboard_summary_definition¶

class DashboardSummaryDefinition(*args, **kwargs)¶

Bases: ModelNormal

Dashboard definition.

Parameters:

author_handle (str, optional) – Identifier of the dashboard author.
created_at (datetime, optional) – Creation date of the dashboard.
description (str, none_type, optional) – Description of the dashboard.
id (str, optional) – Dashboard identifier.
is_read_only (bool, optional) – Whether this dashboard is read-only. If True, only the author and admins can make changes to it.
layout_type (DashboardLayoutType, optional) – Layout type of the dashboard.
modified_at (datetime, optional) – Modification date of the dashboard.
title (str, optional) – Title of the dashboard.
url (str, optional) – URL of the dashboard.

dashboard_template_variable¶

class DashboardTemplateVariable(*args, **kwargs)¶

Bases: ModelNormal

Template variable.

Parameters:

available_values ([str], none_type, optional) – The list of values that the template variable drop-down is limited to.
default (str, none_type, optional) – (deprecated) The default value for the template variable on dashboard load. Cannot be used in conjunction with defaults. Deprecated.
defaults ([str], optional) – One or many default values for template variables on load. If more than one default is specified, they will be unioned together with OR. Cannot be used in conjunction with default.
name (str) – The name of the variable.
prefix (str, none_type, optional) – The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down.

dashboard_template_variable_preset¶

class DashboardTemplateVariablePreset(*args, **kwargs)¶

Bases: ModelNormal

Template variables saved views.

Parameters:

name (str, optional) – The name of the variable.
template_variables ([DashboardTemplateVariablePresetValue], optional) – List of variables.

dashboard_template_variable_preset_value¶

class DashboardTemplateVariablePresetValue(*args, **kwargs)¶

Bases: ModelNormal

Template variables saved views.

Parameters:

name (str, optional) – The name of the variable.
value (str, optional) – (deprecated) The value of the template variable within the saved view. Cannot be used in conjunction with values. Deprecated.
values ([str], optional) – One or many template variable values within the saved view, which will be unioned together using OR if more than one is specified. Cannot be used in conjunction with value.

dashboard_type¶

class DashboardType(*args, **kwargs)¶

Bases: ModelSimple

The type of the associated private dashboard.

Parameters:

value (str) – Must be one of [“custom_timeboard”, “custom_screenboard”].
_check_type (bool) – If True, values for parameters in openapi_types will be type checked and a TypeError will be raised if the wrong type is input. Defaults to True.
_path_to_item (tuple/list) – This is a list of keys or values to drill down to the model in received_data when deserializing a response.
_spec_property_naming (bool) – True if the variable names in the input data are serialized names, as specified in the OpenAPI document. False if the variable names in the input data are pythonic names, e.g. snake case (default).
_configuration (Configuration) – The instance to use when deserializing a file_type parameter. If passed, type conversion is attempted If omitted no type conversion is done.

delete_shared_dashboard_response¶

class DeleteSharedDashboardResponse(*args, **kwargs)¶

Bases: ModelNormal

Response containing token of deleted shared dashboard.

Parameters:: deleted_public_dashboard_token (str, optional) – Token associated with the shared dashboard that was revoked.

deleted_monitor¶

class DeletedMonitor(*args, **kwargs)¶

Bases: ModelNormal

Response from the delete monitor call.

Parameters:: deleted_monitor_id (int, optional) – ID of the deleted monitor.

distribution_point¶

class DistributionPoint(*args, **kwargs)¶: Bases: