Export dashboard

Prev Next
Get
/v1alpha/dashboards/{dashboard_id}/export

Returns a dashboard as a portable template, ready to pass to Import dashboard. The template can contain data from the source workspace, such as user email addresses in widget filters, so review it before sharing it. Every export is recorded in the audit log. The API key must be able to see the dashboard, as described in List dashboards.

Security
HTTP
Type bearer
Path parameters
dashboard_id
stringRequired

The ID of the dashboard to export.

Responses
200

A successful response.

Expand All
object
template
object (v1alphaDashboardTemplate)

A dashboard exported as a portable template, ready to import into a workspace. It contains the dashboard's title, description, and widgets with their layout, and no identifiers, timestamps, creator and updater, or access list.

api_version
string

The template format version. Import dashboard accepts only versions it supports.

Exampletorq.io/v1alpha
kind
string

The kind of template. Always Dashboard.

ExampleDashboard
exported_at
string (date-time)

When the template was exported.

definition
object (v1alphaDashboardDefinition)

Contains the title, description, and widgets of an exported dashboard.

title
string

The dashboard title.

ExampleSOC overview
description
string

The dashboard description.

ExampleOpen cases by severity and assignee
widgets
Array of object

The dashboard widgets, in order. Each widget carries its full definition, including its position on the dashboard and its filters, without identifiers or timestamps. Widgets use Torq's internal dashboard format, which can change. Pass them to Import dashboard unchanged.

object
401

Invalid bearer token. If you receive this message more than once try creating a new Client ID/Client Secret or generating a new bearer token.

object
403

You don't have permission to access this resource.

object