---
title: "Get dashboard template"
method: GET
path: "/internal/v1/dashboard-templates/{project_id}/{template_id}"
tags: ["Dashboards"]
---

# Get dashboard template

`GET /internal/v1/dashboard-templates/{project_id}/{template_id}`

## Request

- Base URL: `https://api.uptrace.dev`
- URL: `https://api.uptrace.dev/internal/v1/dashboard-templates/{project_id}/{template_id}`
- Auth: one of:
  - HTTP bearer
  - API key in query parameter `auth_token`
- TypeScript: <https://skmtc.dev/uptrace/apis/uptrace-json-api/docs/internal/v1/dashboard-templates/:project_id/:template_id/get.ts> (a function with typed inputs; its response is checked against the schema)

Get a specific dashboard template by ID. Returns the template ID, name, description, and tags.

## Path parameters

- `project_id` integer, required
- `template_id` string, required

## Response `200`

Dashboard template.

- GetDashboardTemplateResponse
  - `template` DashboardTemplate, required
    - `id` string, required: Template ID.
    - `name` string, required: Template name.
    - `description` string, required: Template description.
    - `tags` string[]: Template tags.
    - `version` string: Template version.
    - `setupLink` string: Link to setup instructions.
    - `docLink` string: Link to documentation.
    - `status` 'ready' | 'pending' | 'installed', required: Template availability status.
    - `dashboardId` integer: ID of the dashboard created from this template, if any.
    - `yaml` string: Template YAML definition.
  - `yaml` string: Full dashboard template YAML definition.

## Other responses

- `400`: Invalid request
- `401`: Authentication required
- `403`: Insufficient permissions
- `404`: Resource not found

---

[API](https://skmtc.dev/uptrace/apis/uptrace-json-api.md) - [All operations](https://skmtc.dev/uptrace/apis/uptrace-json-api/llms.txt) - [OpenAPI document](https://skmtc.dev/uptrace/apis/uptrace-json-api/revisions/550c8881ab9a?raw)