Skip to main content
API Explorer|API Explorer
Monitoring & Collection/Grafana Integration
POSTGrafanaSince 1.0SynchronousAuth Required

ImportDashboardTemplate

Import a dashboard template into a tenant's Grafana organization

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Request Inputs

Path Parameters

  • templateIdStringRequired

    UUID of the template to import

Body Fields

  • tenantIdStringRequired

    UUID of the tenant importing the template

    Example: tenant-001-xyz

  • datasourceIdStringRequired

    UUID of the datasource to link to the imported dashboard

    Example: ds-001-abc

  • overwriteBooleanRequired

    Whether to overwrite an existing imported dashboard with the same template

    Example: false

  • folderIdIntegerRequired

    Grafana folder ID to import the dashboard into

    Example: 20

Responses

200 OK

On success, this API returns the following response structure.

  • idString

    Unique identifier of the imported dashboard record

    Example: imported-001-abc

  • templateIdString

    UUID of the source template

    Example: tpl-vm-overview

  • grafanaUidString

    Grafana dashboard UID assigned after import

    Example: abcd1234efgh

  • grafanaUrlString

    Direct URL to the imported dashboard in Grafana

    Example: http://grafana.example.com/d/abcd1234efgh

  • datasourceIdString

    UUID of the datasource linked to this dashboard

    Example: ds-001-abc

  • tenantIdString

    UUID of the tenant that imported this dashboard

    Example: tenant-001-xyz

  • importedAtString

    Imported at

    Example: 2026-01-15T08:00:00Z

Endpoint

POST/api/v1/monitoring/grafana/dashboard-templates/{templateId}/import

/api/v1/monitoring/grafana/dashboard-templates/{templateId}/import

Operation ID

ImportDashboardTemplate

Permalink

Request Example

curl -X POST '{host}/api/v1/monitoring/grafana/dashboard-templates/{templateId}/import' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"tenantId":"tenant-001-xyz","datasourceId":"ds-001-abc","overwrite":false,"folderId":20}'

Response Example

200
{
  "id": "imported-001-abc",
  "templateId": "tpl-vm-overview",
  "grafanaUid": "abcd1234efgh",
  "grafanaUrl": "http://grafana.example.com/d/abcd1234efgh",
  "datasourceId": "ds-001-abc",
  "tenantId": "tenant-001-xyz",
  "importedAt": "example"
}

Change History

This API has no change history records yet.

View all change history