Atlassian The Jira Cloud platform REST API — Dashboards

naftiko: 1.0.0-alpha2
info:
  label: Atlassian The Jira Cloud platform REST API — Dashboards
  description: 'Atlassian The Jira Cloud platform REST API — Dashboards. 17 operations. Lead operation: Atlassian Get All
    Dashboards. Self-contained Naftiko capability covering one Atlassian business surface.'
  tags:
  - Atlassian
  - Dashboards
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ATLASSIAN_API_KEY: ATLASSIAN_API_KEY
capability:
  consumes:
  - type: http
    namespace: jira-dashboards
    baseUri: https://your-domain.atlassian.net
    description: Atlassian The Jira Cloud platform REST API — Dashboards business capability. Self-contained, no shared references.
    resources:
    - name: rest-api-3-dashboard
      path: /rest/api/3/dashboard
      operations:
      - name: atlassiangetalldashboards
        method: GET
        description: Atlassian Get All Dashboards
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: filter
          in: query
          type: string
          description: 'The filter applied to the list of dashboards. Valid values are:'
        - name: startAt
          in: query
          type: integer
          description: The index of the first item to return in a page of results (page offset).
        - name: maxResults
          in: query
          type: integer
          description: The maximum number of items to return per page.
      - name: atlassiancreatedashboard
        method: POST
        description: Atlassian Create Dashboard
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-api-3-dashboard-bulk-edit
      path: /rest/api/3/dashboard/bulk/edit
      operations:
      - name: atlassianbulkeditdashboards
        method: PUT
        description: Atlassian Bulk Edit Dashboards
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-api-3-dashboard-gadgets
      path: /rest/api/3/dashboard/gadgets
      operations:
      - name: atlassiangetallavailabledashboardgadgets
        method: GET
        description: Atlassian Get Available Gadgets
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: rest-api-3-dashboard-search
      path: /rest/api/3/dashboard/search
      operations:
      - name: atlassiangetdashboardspaginated
        method: GET
        description: Atlassian Search For Dashboards
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: dashboardName
          in: query
          type: string
          description: String used to perform a case-insensitive partial match with `name`.
        - name: accountId
          in: query
          type: string
          description: User account ID used to return dashboards with the matching `owner.accountId`. This parameter cannot
            be used with the `owner` parameter.
        - name: owner
          in: query
          type: string
          description: This parameter is deprecated because of privacy changes. Use `accountId` instead. See the [migration
            guide](https://developer.atlassian.com/cloud/jira/platform/
        - name: groupname
          in: query
          type: string
          description: As a group's name can change, use of `groupId` is recommended. Group name used to return dashboards
            that are shared with a group that matches `sharePermissions.
        - name: groupId
          in: query
          type: string
          description: Group ID used to return dashboards that are shared with a group that matches `sharePermissions.group.groupId`.
            This parameter cannot be used with the `groupname
        - name: projectId
          in: query
          type: integer
          description: Project ID used to returns dashboards that are shared with a project that matches `sharePermissions.project.id`.
        - name: orderBy
          in: query
          type: string
          description: '[Order](#ordering) the results by a field:'
        - name: startAt
          in: query
          type: integer
          description: The index of the first item to return in a page of results (page offset).
        - name: maxResults
          in: query
          type: integer
          description: The maximum number of items to return per page.
        - name: status
          in: query
          type: string
          description: The status to filter by. It may be active, archived or deleted.
        - name: expand
          in: query
          type: string
          description: Use [expand](#expansion) to include additional information about dashboard in the response. This parameter
            accepts a comma-separated list. Expand options includ
    - name: rest-api-3-dashboard-dashboardId-gadget
      path: /rest/api/3/dashboard/{dashboardId}/gadget
      operations:
      - name: atlassiangetallgadgets
        method: GET
        description: Atlassian Get Gadgets
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: dashboardId
          in: path
          type: integer
          description: The ID of the dashboard.
          required: true
        - name: moduleKey
          in: query
          type: array
          description: 'The list of gadgets module keys. To include multiple module keys, separate module keys with ampersand:
            `moduleKey=key:one&moduleKey=key:two`.'
        - name: uri
          in: query
          type: array
          description: 'The list of gadgets URIs. To include multiple URIs, separate URIs with ampersand: `uri=/rest/example/uri/1&uri=/rest/example/uri/2`.'
        - name: gadgetId
          in: query
          type: array
          description: 'The list of gadgets IDs. To include multiple IDs, separate IDs with ampersand: `gadgetId=10000&gadgetId=10001`.'
      - name: atlassianaddgadget
        method: POST
        description: Atlassian Add Gadget To Dashboard
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: dashboardId
          in: path
          type: integer
          description: The ID of the dashboard.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-api-3-dashboard-dashboardId-gadget-gadgetId
      path: /rest/api/3/dashboard/{dashboardId}/gadget/{gadgetId}
      operations:
      - name: atlassianremovegadget
        method: DELETE
        description: Atlassian Remove Gadget From Dashboard
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: dashboardId
          in: path
          type: integer
          description: The ID of the dashboard.
          required: true
        - name: gadgetId
          in: path
          type: integer
          description: The ID of the gadget.
          required: true
      - name: atlassianupdategadget
        method: PUT
        description: Atlassian Update Gadget On Dashboard
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: dashboardId
          in: path
          type: integer
          description: The ID of the dashboard.
          required: true
        - name: gadgetId
          in: path
          type: integer
          description: The ID of the gadget.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-api-3-dashboard-dashboardId-items-itemId-properties
      path: /rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties
      operations:
      - name: atlassiangetdashboarditempropertykeys
        method: GET
        description: Atlassian Get Dashboard Item Property Keys
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: dashboardId
          in: path
          type: string
          description: The ID of the dashboard.
          required: true
        - name: itemId
          in: path
          type: string
          description: The ID of the dashboard item.
          required: true
    - name: rest-api-3-dashboard-dashboardId-items-itemId-properties-propertyKey
      path: /rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}
      operations:
      - name: atlassiandeletedashboarditemproperty
        method: DELETE
        description: Atlassian Delete Dashboard Item Property
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: dashboardId
          in: path
          type: string
          description: The ID of the dashboard.
          required: true
        - name: itemId
          in: path
          type: string
          description: The ID of the dashboard item.
          required: true
        - name: propertyKey
          in: path
          type: string
          description: The key of the dashboard item property.
          required: true
      - name: atlassiangetdashboarditemproperty
        method: GET
        description: Atlassian Get Dashboard Item Property
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: dashboardId
          in: path
          type: string
          description: The ID of the dashboard.
          required: true
        - name: itemId
          in: path
          type: string
          description: The ID of the dashboard item.
          required: true
        - name: propertyKey
          in: path
          type: string
          description: The key of the dashboard item property.
          required: true
      - name: atlassiansetdashboarditemproperty
        method: PUT
        description: Atlassian Set Dashboard Item Property
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: dashboardId
          in: path
          type: string
          description: The ID of the dashboard.
          required: true
        - name: itemId
          in: path
          type: string
          description: The ID of the dashboard item.
          required: true
        - name: propertyKey
          in: path
          type: string
          description: The key of the dashboard item property. The maximum length is 255 characters. For dashboard items with
            a spec URI and no complete module key, if the provided pr
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-api-3-dashboard-id
      path: /rest/api/3/dashboard/{id}
      operations:
      - name: atlassiandeletedashboard
        method: DELETE
        description: Atlassian Delete Dashboard
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the dashboard.
          required: true
      - name: atlassiangetdashboard
        method: GET
        description: Atlassian Get Dashboard
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the dashboard.
          required: true
      - name: atlassianupdatedashboard
        method: PUT
        description: Atlassian Update Dashboard
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the dashboard to update.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rest-api-3-dashboard-id-copy
      path: /rest/api/3/dashboard/{id}/copy
      operations:
      - name: atlassiancopydashboard
        method: POST
        description: Atlassian Copy Dashboard
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.ATLASSIAN_API_KEY}}'
  exposes:
  - type: rest
    namespace: jira-dashboards-rest
    port: 8080
    description: REST adapter for Atlassian The Jira Cloud platform REST API — Dashboards. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/api/3/dashboard
      name: rest-api-3-dashboard
      description: REST surface for rest-api-3-dashboard.
      operations:
      - method: GET
        name: atlassiangetalldashboards
        description: Atlassian Get All Dashboards
        call: jira-dashboards.atlassiangetalldashboards
        with:
          filter: rest.filter
          startAt: rest.startAt
          maxResults: rest.maxResults
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: atlassiancreatedashboard
        description: Atlassian Create Dashboard
        call: jira-dashboards.atlassiancreatedashboard
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/dashboard/bulk/edit
      name: rest-api-3-dashboard-bulk-edit
      description: REST surface for rest-api-3-dashboard-bulk-edit.
      operations:
      - method: PUT
        name: atlassianbulkeditdashboards
        description: Atlassian Bulk Edit Dashboards
        call: jira-dashboards.atlassianbulkeditdashboards
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/dashboard/gadgets
      name: rest-api-3-dashboard-gadgets
      description: REST surface for rest-api-3-dashboard-gadgets.
      operations:
      - method: GET
        name: atlassiangetallavailabledashboardgadgets
        description: Atlassian Get Available Gadgets
        call: jira-dashboards.atlassiangetallavailabledashboardgadgets
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/dashboard/search
      name: rest-api-3-dashboard-search
      description: REST surface for rest-api-3-dashboard-search.
      operations:
      - method: GET
        name: atlassiangetdashboardspaginated
        description: Atlassian Search For Dashboards
        call: jira-dashboards.atlassiangetdashboardspaginated
        with:
          dashboardName: rest.dashboardName
          accountId: rest.accountId
          owner: rest.owner
          groupname: rest.groupname
          groupId: rest.groupId
          projectId: rest.projectId
          orderBy: rest.orderBy
          startAt: rest.startAt
          maxResults: rest.maxResults
          status: rest.status
          expand: rest.expand
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/dashboard/{dashboardid}/gadget
      name: rest-api-3-dashboard-dashboardid-gadget
      description: REST surface for rest-api-3-dashboard-dashboardId-gadget.
      operations:
      - method: GET
        name: atlassiangetallgadgets
        description: Atlassian Get Gadgets
        call: jira-dashboards.atlassiangetallgadgets
        with:
          dashboardId: rest.dashboardId
          moduleKey: rest.moduleKey
          uri: rest.uri
          gadgetId: rest.gadgetId
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: atlassianaddgadget
        description: Atlassian Add Gadget To Dashboard
        call: jira-dashboards.atlassianaddgadget
        with:
          dashboardId: rest.dashboardId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/dashboard/{dashboardid}/gadget/{gadgetid}
      name: rest-api-3-dashboard-dashboardid-gadget-gadgetid
      description: REST surface for rest-api-3-dashboard-dashboardId-gadget-gadgetId.
      operations:
      - method: DELETE
        name: atlassianremovegadget
        description: Atlassian Remove Gadget From Dashboard
        call: jira-dashboards.atlassianremovegadget
        with:
          dashboardId: rest.dashboardId
          gadgetId: rest.gadgetId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: atlassianupdategadget
        description: Atlassian Update Gadget On Dashboard
        call: jira-dashboards.atlassianupdategadget
        with:
          dashboardId: rest.dashboardId
          gadgetId: rest.gadgetId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/dashboard/{dashboardid}/items/{itemid}/properties
      name: rest-api-3-dashboard-dashboardid-items-itemid-properties
      description: REST surface for rest-api-3-dashboard-dashboardId-items-itemId-properties.
      operations:
      - method: GET
        name: atlassiangetdashboarditempropertykeys
        description: Atlassian Get Dashboard Item Property Keys
        call: jira-dashboards.atlassiangetdashboarditempropertykeys
        with:
          dashboardId: rest.dashboardId
          itemId: rest.itemId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/dashboard/{dashboardid}/items/{itemid}/properties/{propertykey}
      name: rest-api-3-dashboard-dashboardid-items-itemid-properties-propertykey
      description: REST surface for rest-api-3-dashboard-dashboardId-items-itemId-properties-propertyKey.
      operations:
      - method: DELETE
        name: atlassiandeletedashboarditemproperty
        description: Atlassian Delete Dashboard Item Property
        call: jira-dashboards.atlassiandeletedashboarditemproperty
        with:
          dashboardId: rest.dashboardId
          itemId: rest.itemId
          propertyKey: rest.propertyKey
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: atlassiangetdashboarditemproperty
        description: Atlassian Get Dashboard Item Property
        call: jira-dashboards.atlassiangetdashboarditemproperty
        with:
          dashboardId: rest.dashboardId
          itemId: rest.itemId
          propertyKey: rest.propertyKey
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: atlassiansetdashboarditemproperty
        description: Atlassian Set Dashboard Item Property
        call: jira-dashboards.atlassiansetdashboarditemproperty
        with:
          dashboardId: rest.dashboardId
          itemId: rest.itemId
          propertyKey: rest.propertyKey
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/dashboard/{id}
      name: rest-api-3-dashboard-id
      description: REST surface for rest-api-3-dashboard-id.
      operations:
      - method: DELETE
        name: atlassiandeletedashboard
        description: Atlassian Delete Dashboard
        call: jira-dashboards.atlassiandeletedashboard
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: atlassiangetdashboard
        description: Atlassian Get Dashboard
        call: jira-dashboards.atlassiangetdashboard
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: atlassianupdatedashboard
        description: Atlassian Update Dashboard
        call: jira-dashboards.atlassianupdatedashboard
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/3/dashboard/{id}/copy
      name: rest-api-3-dashboard-id-copy
      description: REST surface for rest-api-3-dashboard-id-copy.
      operations:
      - method: POST
        name: atlassiancopydashboard
        description: Atlassian Copy Dashboard
        call: jira-dashboards.atlassiancopydashboard
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: jira-dashboards-mcp
    port: 9090
    transport: http
    description: MCP adapter for Atlassian The Jira Cloud platform REST API — Dashboards. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: atlassian-get-all-dashboards
      description: Atlassian Get All Dashboards
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: jira-dashboards.atlassiangetalldashboards
      with:
        filter: tools.filter
        startAt: tools.startAt
        maxResults: tools.maxResults
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-create-dashboard
      description: Atlassian Create Dashboard
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: jira-dashboards.atlassiancreatedashboard
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-bulk-edit-dashboards
      description: Atlassian Bulk Edit Dashboards
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: jira-dashboards.atlassianbulkeditdashboards
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-get-available-gadgets
      description: Atlassian Get Available Gadgets
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: jira-dashboards.atlassiangetallavailabledashboardgadgets
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-search-dashboards
      description: Atlassian Search For Dashboards
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: jira-dashboards.atlassiangetdashboardspaginated
      with:
        dashboardName: tools.dashboardName
        accountId: tools.accountId
        owner: tools.owner
        groupname: tools.groupname
        groupId: tools.groupId
        projectId: tools.projectId
        orderBy: tools.orderBy
        startAt: tools.startAt
        maxResults: tools.maxResults
        status: tools.status
        expand: tools.expand
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-get-gadgets
      description: Atlassian Get Gadgets
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: jira-dashboards.atlassiangetallgadgets
      with:
        dashboardId: tools.dashboardId
        moduleKey: tools.moduleKey
        uri: tools.uri
        gadgetId: tools.gadgetId
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-add-gadget-dashboard
      description: Atlassian Add Gadget To Dashboard
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: jira-dashboards.atlassianaddgadget
      with:
        dashboardId: tools.dashboardId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-remove-gadget-dashboard
      description: Atlassian Remove Gadget From Dashboard
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: jira-dashboards.atlassianremovegadget
      with:
        dashboardId: tools.dashboardId
        gadgetId: tools.gadgetId
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-update-gadget-dashboard
      description: Atlassian Update Gadget On Dashboard
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: jira-dashboards.atlassianupdategadget
      with:
        dashboardId: tools.dashboardId
        gadgetId: tools.gadgetId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-get-dashboard-item-property
      description: Atlassian Get Dashboard Item Property Keys
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: jira-dashboards.atlassiangetdashboarditempropertykeys
      with:
        dashboardId: tools.dashboardId
        itemId: tools.itemId
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-delete-dashboard-item-property
      description: Atlassian Delete Dashboard Item Property
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: jira-dashboards.atlassiandeletedashboarditemproperty
      with:
        dashboardId: tools.dashboardId
        itemId: tools.itemId
        propertyKey: tools.propertyKey
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-get-dashboard-item-property-2
      description: Atlassian Get Dashboard Item Property
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: jira-dashboards.atlassiangetdashboarditemproperty
      with:
        dashboardId: tools.dashboardId
        itemId: tools.itemId
        propertyKey: tools.propertyKey
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-set-dashboard-item-property
      description: Atlassian Set Dashboard Item Property
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: jira-dashboards.atlassiansetdashboarditemproperty
      with:
        dashboardId: tools.dashboardId
        itemId: tools.itemId
        propertyKey: tools.propertyKey
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-delete-dashboard
      description: Atlassian Delete Dashboard
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: jira-dashboards.atlassiandeletedashboard
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-get-dashboard
      description: Atlassian Get Dashboard
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: jira-dashboards.atlassiangetdashboard
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-update-dashboard
      description: Atlassian Update Dashboard
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: jira-dashboards.atlassianupdatedashboard
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-copy-dashboard
      description: Atlassian Copy Dashboard
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: jira-dashboards.atlassiancopydashboard
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.