Method: legacySoarDashboard.legacyGetDashboardWidgetDefinitions

• HTTP request
• Path parameters
• Request body
• Response body
  • JSON representation
• Authorization scopes
• IAM Permissions
• DashboardWidgetDefinitionDataModel
  • JSON representation
• DashboardWidgetTypesEnum

Full name: projects.locations.instances.legacySoarDashboard.legacyGetDashboardWidgetDefinitions

Returns all available widget definitions that can be used to construct a dashboard. This includes predefined templates for various SOC metrics and chart types.

HTTP request

Choose a location:

africa-south1 asia-northeast1 asia-south1 asia-southeast1 asia-southeast2 australia-southeast1 europe-central2 europe-west12 europe-west2 europe-west3 europe-west6 europe-west9 me-central1 me-central2 me-west1 northamerica-northeast2 southamerica-east1 us eu

GET https://chronicle.africa-south1.rep.googleapis.com/v1alpha/{instance}/legacySoarDashboard:legacyGetDashboardWidgetDefinitions

Path parameters

Parameters
instance	string Required. The instance to get the dashboard widget definitions for. Format: projects/{project}/locations/{location}/instances/{instance}

Request body

The request body must be empty.

Response body

GetLegacySoarDashboardWidgetDefinitionsResponse represents the response for getting dashboard widget definitions.

If successful, the response body contains data with the following structure:

JSON representation
{ "payload": [ { object (DashboardWidgetDefinitionDataModel) } ] }

Fields
payload[]	object (DashboardWidgetDefinitionDataModel) Optional. The data model of the dashboard widget definitions.

Authorization scopes

Requires one of the following OAuth scopes:

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/chronicle
• https://www.googleapis.com/auth/chronicle.readonly

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the instance resource:

• chronicle.legacySoarDashboards.get

For more information, see the IAM documentation.

DashboardWidgetDefinitionDataModel

DashboardWidgetDefinitionDataModel represents the data model for a dashboard widget definition.

JSON representation
{ "id": integer, "name": string, "description": string, "widgetPreviewImage": string, "widgetType": enum (DashboardWidgetTypesEnum), "axisXDescription": string, "axisYDescription": string, "creationTimeUnixTimeInMs": string, "modificationTimeUnixTimeInMs": string }

Fields
id	integer Optional. The ID of the widget.
name	string Optional. The name of the widget.
description	string Optional. The description of the widget.
widgetPreviewImage	string Optional. The widget preview image.
widgetType	enum (DashboardWidgetTypesEnum) Optional. The type of the widget.
axisXDescription	string Optional. The description of the x axis.
axisYDescription	string Optional. The description of the y axis.
creationTimeUnixTimeInMs	string (int64 format) Optional. The creation time of the widget in Unix time in milliseconds.
modificationTimeUnixTimeInMs	string (int64 format) Optional. The update time of the widget in Unix time in milliseconds.

DashboardWidgetTypesEnum

DashboardWidgetTypesEnum is an enum that represents the widget types for a dashboard.

Enums
DASHBOARD_WIDGET_TYPE_UNSPECIFIED	Unspecified widget type
CUSTOM	Custom type
PLAYBOOK_MONITORING	Playbook monitoring