---
title: "Assign dashboard to edge (assignDashboardToEdge)"
method: POST
path: "/api/edge/{edgeId}/dashboard/{dashboardId}"
tags: ["dashboard-controller"]
---

# Assign dashboard to edge (assignDashboardToEdge)

`POST /api/edge/{edgeId}/dashboard/{dashboardId}`

Creates assignment of an existing dashboard to an instance of The Edge. Assignment works in async way - first, notification event pushed to edge service queue on platform. Second, remote edge service will receive a copy of assignment dashboard (Edge will receive this instantly, if it's currently connected, or once it's going to be connected to platform). Third, once dashboard will be delivered to edge service, it's going to be available for usage on remote edge instance.

Available for users with 'TENANT_ADMIN' authority.

## Path parameters

- `edgeId` string, required
- `dashboardId` string, required

## Response `200`

OK

- Dashboard
  - `title` string, required — Title of the dashboard.
  - `image` string — Thumbnail picture for rendering of the dashboards in a grid view on mobile devices.
  - `mobileHide` boolean — Hide dashboard from mobile devices. Useful if the dashboard is not designed for small screens.
  - `mobileOrder` integer — Order on mobile devices. Useful to adjust sorting of the dashboards for mobile applications
  - `configuration` unknown
  - `name` string — Same as title of the dashboard. Read-only field. Update the 'title' to change the 'name' of the dashboard.
  - `resources` ResourceExportData[]
    - `link` string
    - `title` string
    - `type` 'LWM2M_MODEL' | 'JKS' | 'PKCS_12' | 'JS_MODULE' | 'IMAGE' | 'DASHBOARD' | 'GENERAL'
    - `subType` 'IMAGE' | 'SCADA_SYMBOL' | 'EXTENSION' | 'MODULE'
    - `resourceKey` string
    - `fileName` string
    - `publicResourceKey` string
    - `isPublic` boolean
    - `mediaType` string
    - `data` string
    - `public` boolean
  - `id` DashboardId
    - `id` string, uuid, required — ID of the entity, time-based UUID v1
    - `entityType` 'DASHBOARD', required — string
  - `createdTime` integer — Timestamp of the dashboard creation, in milliseconds
  - `tenantId` TenantId
    - `id` string, uuid, required — ID of the entity, time-based UUID v1
    - `entityType` 'TENANT', required — string
  - `assignedCustomers` ShortCustomerInfo[] — List of assigned customers with their info.
    - `customerId` CustomerId
      - `id` string, uuid, required — ID of the entity, time-based UUID v1
      - `entityType` 'CUSTOMER', required — string
    - `title` string — Title of the customer.
    - `isPublic` boolean
    - `public` boolean
  - `version` integer

---

[API](https://skmtc.net/thingsboard/apis/thingsboard-rest-api.md) · [All operations](https://skmtc.net/thingsboard/apis/thingsboard-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/thingsboard/thingsboard-rest-api/revisions/40169ccdec5c/schema)