Hierarchy

Constructors

Properties

widgets: Widgets = ...

Methods

  • Parameters

    Returns Promise<{
        dashboard: string;
    }>

    Description

    Creates a new dashboard in your application.

    See

    https://help.tago.io/portal/en/kb/articles/15-dashboard-overview Dashboard Overview

    Example

    If receive an error "Authorization Denied", check policy Dashboard / Create in Access Management.

    const result = await Resources.dashboards.create({
    label: "My Dashboard",
    tags: [{ key: "type", value: "monitoring" }]
    });
    console.log(result); // { dashboard: 'dashboard-id-123' }
  • Parameters

    • dashboardID: string

    Returns Promise<string>

    Description

    Deletes a dashboard from the application.

    See

    https://help.tago.io/portal/en/kb/articles/15-dashboard-overview Dashboard Overview

    Example

    If receive an error "Authorization Denied", check policy Dashboard / Delete in Access Management.

    const result = await Resources.dashboards.delete("dashboard-id-123");
    console.log(result); // Successfully Removed
  • Parameters

    • dashboardID: string
    • Optional dashboardObj: {
          new_label?: string;
          setup?: object;
      }
      • Optional new_label?: string
      • Optional setup?: object

    Returns Promise<{
        dashboard_id: string;
        message: string;
    }>

    Description

    Creates a copy of an existing dashboard.

    See

    https://help.tago.io/portal/en/kb/articles/15-dashboard-overview Dashboard Overview

    Example

    If receive an error "Authorization Denied", check policy Dashboard / Duplicate in Access Management.

    const result = await Resources.dashboards.duplicate("dashboard-id-123", { new_label: "Copy of My Dashboard" });
    console.log(result);
  • Parameters

    Returns Promise<string>

    Description

    Modifies an existing dashboard's properties.

    See

    https://help.tago.io/portal/en/kb/articles/15-dashboard-overview Dashboard Overview

    Example

    If receive an error "Authorization Denied", check policy Dashboard / Edit in Access Management.

    const result = await Resources.dashboards.edit("dashboard-id-123", {
    label: "Updated Dashboard",
    active: false
    });
    console.log(result); // Successfully Updated