Open Context Protocol is live! 🚀 Read the launch post
getAllAvailableDashboardGadgets

getAllAvailableDashboardGadgets

Get available gadgets

Details

  • Method: GET
  • Path: /rest/api/3/dashboard/gadgets
  • Operation ID: getAllAvailableDashboardGadgets

Parameters

{}

Response Schema

{
  "additionalProperties": false,
  "description": "The list of available gadgets.",
  "properties": {
    "gadgets": {
      "description": "The list of available gadgets.",
      "items": {
        "additionalProperties": false,
        "description": "The details of the available dashboard gadget.",
        "properties": {
          "moduleKey": {
            "description": "The module key of the gadget type.",
            "readOnly": true,
            "type": "string"
          },
          "title": {
            "description": "The title of the gadget.",
            "readOnly": true,
            "type": "string"
          },
          "uri": {
            "description": "The URI of the gadget type.",
            "readOnly": true,
            "type": "string"
          }
        },
        "required": [
          "title"
        ],
        "type": "object"
      },
      "readOnly": true,
      "type": "array"
    }
  },
  "required": [
    "gadgets"
  ],
  "type": "object"
}

Usage

from ocp_agent import OCPAgent

agent = OCPAgent()
await agent.register_api('jira')

# Call this tool
result = await agent.call_tool('getAllAvailableDashboardGadgets', {
    # Add required parameters here
})