thousandeyes-sdk-python/thousandeyes-sdk-dashboards/docs/CloneDashboardRequest.md

CloneDashboardRequest

Optional values that override settings inherited from the source dashboard. Omit the request body or send an empty object ({}) to clone the dashboard without overrides.

Properties

Name	Type	Description	Notes
title	str	Title of the cloned dashboard. If omitted, the API generates a unique title.	[optional]
tag_ids	List[str]	Dashboard tag identifiers. An empty array clears tags from the clone; omission preserves the source dashboard's tags.	[optional]
description	str	Description for the cloned dashboard.	[optional]
layout	DashboardLayout		[optional]
default_timespan	DefaultTimespan		[optional]
is_global_override	bool	If `true`, the dashboard time range overrides local widget time settings.	[optional]
refresh_rate	CloneDashboardRefreshRate		[optional]
global_filter_id	str	Global filter applied to the cloned dashboard. If omitted, the source dashboard's filter is preserved when cloning within the same account group. When cloning across account groups, the filter is cleared.	[optional]
shared_account_ids	List[str]	Account group IDs with which to share the cloned dashboard. An empty array limits sharing to current account group. Omission does not share with other account groups. The `isPrivate` setting controls visibility within the current account group. Cannot be used together with `isSharedWithAllAccountGroups=true`	[optional]
is_shared_with_all_account_groups	bool	When `true`, shares the cloned dashboard with all account groups available to the user. Cannot be used together with `sharedAccountIds`.	[optional]
is_private	bool	When `true`, only the creator can view the cloned dashboard. Combining this property with `sharedAccountIds` or `isSharedWithAllAccountGroups=true` returns `400 Bad Request`. Defaults to `false`.	[optional] [default to False]
is_default_for_user	bool	When `true`, sets the cloned dashboard as the current user's default dashboard.	[optional]
is_default_for_account	bool	When `true`, sets the cloned dashboard as the current account group's default dashboard.	[optional]

Example

from thousandeyes_sdk.dashboards.models.clone_dashboard_request import CloneDashboardRequest

# TODO update the JSON string below
json = "{}"
# create an instance of CloneDashboardRequest from a JSON string
clone_dashboard_request_instance = CloneDashboardRequest.from_json(json)
# print the JSON string representation of the object
print(CloneDashboardRequest.to_json())

# convert the object into a dict
clone_dashboard_request_dict = clone_dashboard_request_instance.to_dict()
# create an instance of CloneDashboardRequest from a dict
clone_dashboard_request_from_dict = CloneDashboardRequest.from_dict(clone_dashboard_request_dict)

[Back to Model list] [Back to API list] [Back to README]