diff --git a/README.md b/README.md index d904d76..0c740ac 100644 --- a/README.md +++ b/README.md @@ -2892,20 +2892,11 @@ except Exception as e: #### Export Dashboards -Export one or more dashboards to a dictionary. +Export dashboard to a dictionary. ```python -import os -from secops.chronicle import client - -# Assumes the CHRONICLE_SA_KEY environment variable is set with service account JSON -chronicle_client = client.Client() - -# Export a single dashboard +# Export a dashboard dashboards = chronicle.export_dashboard(dashboard_names=[""]) - -# Export multiple dashboards -dashboards = chronicle.export_dashboard(dashboard_names=["", ""]) ``` diff --git a/src/secops/chronicle/client.py b/src/secops/chronicle/client.py index 0c8773f..4f8b02b 100644 --- a/src/secops/chronicle/client.py +++ b/src/secops/chronicle/client.py @@ -3964,6 +3964,7 @@ def import_dashboard(self, dashboard: dict[str, Any]) -> dict[str, Any]: def export_dashboard(self, dashboard_names: list[str]) -> dict[str, Any]: """Export native dashboards. + It supports single dashboard export operation only. Args: dashboard_names: List of dashboard resource names to export. diff --git a/src/secops/chronicle/dashboard.py b/src/secops/chronicle/dashboard.py index 16b1806..29fd5c1 100644 --- a/src/secops/chronicle/dashboard.py +++ b/src/secops/chronicle/dashboard.py @@ -164,6 +164,7 @@ def import_dashboard(client, dashboard: dict[str, Any]) -> dict[str, Any]: def export_dashboard(client, dashboard_names: list[str]) -> dict[str, Any]: """Export native dashboards. + It supports single dashboard export operation only. Args: client: ChronicleClient instance