MaDDash API Reference

This page describes the Monitoring and Debugging Dashboard (MaDDash) API. The API uses a JSON data format and attempts to adhere closely to principles of REST. The interface provides access to the following types of resources:

• Dashboard: A collection of one or more grid resources. The grouping of grids into a dashboard as defined by the creator of the dashboard resource.

• Grid: A two-dimensional representation of one or more rows and columns of checks that measure some value between entities represented by the column value (x) and row value (y).

• Check: The output of a task performed using the column value (x) and the row value (y) as input.

• Column: A collection of checks that share a common x value.

• Row: A collection of checks that share a common y value

• Cell: A collection of checks that share a common x and y value

A visual representation of these resources is provided in the figure below:

API Guide

• Dashboards
  • Retrieving the list of dashboards
• Grids
  • Retrieving the list of grids
  • Retrieving a single grid
• Rows
  • Retrieving a row
• Cells
  • Retrieving a cell
• Checks
  • Retrieving a single check
  • Rescheduling checks
• Events
  • Retrieving a list of events
  • Retrieving a single event
  • Creating an Event
  • Deleting an Event
• Reports
  • Retrieving a report
• Appendix: Check Type Specific Parameters
  • Nagios Check
  • perfSONAR Nagios Check
• Miscellaneous Operations
  • Listing all the unique row names
  • Listing all the unique column names
  • Listing all the unique check names