Skip to main content
POST
/
dashboards
/
update
Create/Update Dashboard
curl --request POST \
  --url https://us-east.metoro.io/api/v1/dashboards/update \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "dashboard": {
    "settings": {
      "hideGlobalEnvironmentSelector": false,
      "defaultTimeRange": "defaultTimeRange"
    },
    "metadata": {
      "id": "id",
      "title": "title",
      "folderPath": "/dashboards/default/"
    },
    "content": {
      "variables": [
        {
          "defaultValue": "defaultValue",
          "overridable": true,
          "name": "name",
          "selectorSettings": {
            "metricName": "metricName",
            "attribute": "attribute"
          }
        },
        {
          "defaultValue": "defaultValue",
          "overridable": true,
          "name": "name",
          "selectorSettings": {
            "metricName": "metricName",
            "attribute": "attribute"
          }
        }
      ],
      "title": "title",
      "widgets": []
    }
  }
}
'
{
  "id": "id"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Dashboard to create or update

Request to create or update a dashboard

dashboard
object
required

Dashboard object

Example:
{
  "settings": {
    "hideGlobalEnvironmentSelector": false,
    "defaultTimeRange": "defaultTimeRange"
  },
  "metadata": {
    "id": "id",
    "title": "title",
    "folderPath": "/dashboards/default/"
  },
  "content": {
    "variables": [
      {
        "defaultValue": "defaultValue",
        "overridable": true,
        "name": "name",
        "selectorSettings": {
          "metricName": "metricName",
          "attribute": "attribute"
        }
      },
      {
        "defaultValue": "defaultValue",
        "overridable": true,
        "name": "name",
        "selectorSettings": {
          "metricName": "metricName",
          "attribute": "attribute"
        }
      }
    ],
    "title": "title",
    "widgets": []
  }
}

Response

Dashboard created or updated successfully

Response from creating or updating a dashboard

id
string
required

Unique identifier of the created/updated dashboard