DAdatadog
Dashboard Lists

Update a dashboard list

Update the name of a dashboard list.

put/api/v1/dashboard/lists/manual/{list_id}

Request

  • Base URL
    https://api.datadoghq.com
  • URL
    https://api.datadoghq.com/api/v1/dashboard/lists/manual/{list_id}
  • Auth
    • API key in header DD-API-KEY and API key in header DD-APPLICATION-KEY
    • or OAuth 2
      Authorization code: /oauth2/v1/authorize
      Token URL: /oauth2/v1/token scopes: dashboards_write

Path parameters

list_idinteger required

ID of the dashboard list to update.

Request body

createdstring date-time

Date of creation of the dashboard list.

dashboard_countinteger

The number of dashboards in the list.

idinteger

The ID of the dashboard list.

is_favoriteboolean

Whether or not the list is in the favorites.

modifiedstring date-time

Date of last edition of the dashboard list.

namestring required

The name of the dashboard list.

typestring

The type of dashboard list.

Example request

{
  "name": "My Dashboard",
  "type": "manual_dashboard_list"
}

Response

OK

createdstring date-time

Date of creation of the dashboard list.

dashboard_countinteger

The number of dashboards in the list.

idinteger

The ID of the dashboard list.

is_favoriteboolean

Whether or not the list is in the favorites.

modifiedstring date-time

Date of last edition of the dashboard list.

namestring required

The name of the dashboard list.

typestring

The type of dashboard list.

Example response

{
  "name": "My Dashboard",
  "type": "manual_dashboard_list"
}

Changes

No recorded changes to this operation across all 1 revision of this API.