---
title: "Add gadget to dashboard"
method: POST
path: "/rest/api/3/dashboard/{dashboardId}/gadget"
tags: ["Dashboards"]
---

# Add gadget to dashboard

`POST /rest/api/3/dashboard/{dashboardId}/gadget`

Adds a gadget to a dashboard.

**[Permissions](#permissions) required:** None.

## Path parameters

- `dashboardId` integer, required

## Request body

- DashboardGadgetSettings — Details of the settings for a dashboard gadget.
  - `color` string — The color of the gadget. Should be one of `blue`, `red`, `yellow`, `green`, `cyan`, `purple`, `gray`, or `white`.
  - `ignoreUriAndModuleKeyValidation` boolean — Whether to ignore the validation of module key and URI. For example, when a gadget is created that is a part of an application that isn't installed.
  - `moduleKey` string — The module key of the gadget type. Can't be provided with `uri`.
  - `position` DashboardGadgetPosition — Details of a gadget position.
    - `The column position of the gadget.` integer, required
    - `The row position of the gadget.` integer, required
  - `title` string — The title of the gadget.
  - `uri` string — The URI of the gadget type. Can't be provided with `moduleKey`.

## Response `200`

Returned if the request is successful.

- DashboardGadget — Details of a gadget.
  - `color` 'blue' | 'red' | 'yellow' | 'green' | 'cyan' | 'purple' | 'gray' | 'white', required — The color of the gadget. Should be one of `blue`, `red`, `yellow`, `green`, `cyan`, `purple`, `gray`, or `white`.
  - `id` integer, required — The ID of the gadget instance.
  - `moduleKey` string — The module key of the gadget type.
  - `position` DashboardGadgetPosition, required — Details of a gadget position.
    - `The column position of the gadget.` integer, required
    - `The row position of the gadget.` integer, required
  - `title` string, required — The title of the gadget.
  - `uri` string — The URI of the gadget type.

## Other responses

- `400` — Returned if the request is invalid.
- `401` — Returned if the authentication credentials are incorrect or missing.
- `404` — Returned if the dashboard is not found.

---

[API](https://skmtc.net/atlassian/apis/the-jira-cloud-platform-rest-api-2.md) · [All operations](https://skmtc.net/atlassian/apis/the-jira-cloud-platform-rest-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/atlassian/the-jira-cloud-platform-rest-api-2/versions/5a51740d7ab3/schema)