--- title: Create a dashboard list description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Dashboard Lists --- # Create a dashboard list{% #create-a-dashboard-list %} Copy pageCopied {% tab title="v1" %} | Datadog site | API endpoint | | ----------------- | ---------------------------------------------------------------- | | ap1.datadoghq.com | POST https://api.ap1.datadoghq.com/api/v1/dashboard/lists/manual | | ap2.datadoghq.com | POST https://api.ap2.datadoghq.com/api/v1/dashboard/lists/manual | | app.datadoghq.eu | POST https://api.datadoghq.eu/api/v1/dashboard/lists/manual | | app.ddog-gov.com | POST https://api.ddog-gov.com/api/v1/dashboard/lists/manual | | us2.ddog-gov.com | POST https://api.us2.ddog-gov.com/api/v1/dashboard/lists/manual | | app.datadoghq.com | POST https://api.datadoghq.com/api/v1/dashboard/lists/manual | | us3.datadoghq.com | POST https://api.us3.datadoghq.com/api/v1/dashboard/lists/manual | | us5.datadoghq.com | POST https://api.us5.datadoghq.com/api/v1/dashboard/lists/manual | ### Overview Create an empty dashboard list. This endpoint requires the `dashboards_write` permission. OAuth apps require the `dashboards_write` authorization [scope](https://docs.datadoghq.com/api/latest/scopes.md#dashboard-lists) to access this endpoint. ### Request #### Body Data (required) Create a dashboard list request body. {% tab title="Model" %} | Parent field | Field | Type | Description | | ------------ | ---------------------- | --------- | ---------------------------------------------------- | | | author | object | Object describing the creator of the shared element. | | author | email | string | Email of the creator. | | author | handle | string | Handle of the creator. | | author | name | string | Name of the creator. | | | created | date-time | Date of creation of the dashboard list. | | | dashboard_count | int64 | The number of dashboards in the list. | | | id | int64 | The ID of the dashboard list. | | | is_favorite | boolean | Whether or not the list is in the favorites. | | | modified | date-time | Date of last edition of the dashboard list. | | | name [*required*] | string | The name of the dashboard list. | | | type | string | The type of dashboard list. | {% /tab %} {% tab title="Example" %} ```json { "name": "Example-Dashboard-List" } ``` {% /tab %} ### Response {% tab title="200" %} OK {% tab title="Model" %} Your Datadog Dashboards. | Parent field | Field | Type | Description | | ------------ | ---------------------- | --------- | ---------------------------------------------------- | | | author | object | Object describing the creator of the shared element. | | author | email | string | Email of the creator. | | author | handle | string | Handle of the creator. | | author | name | string | Name of the creator. | | | created | date-time | Date of creation of the dashboard list. | | | dashboard_count | int64 | The number of dashboards in the list. | | | id | int64 | The ID of the dashboard list. | | | is_favorite | boolean | Whether or not the list is in the favorites. | | | modified | date-time | Date of last edition of the dashboard list. | | | name [*required*] | string | The name of the dashboard list. | | | type | string | The type of dashboard list. | {% /tab %} {% tab title="Example" %} ```json { "author": { "email": "string", "handle": "string", "name": "string" }, "created": "2019-09-19T10:00:00.000Z", "dashboard_count": "integer", "id": "integer", "is_favorite": false, "modified": "2019-09-19T10:00:00.000Z", "name": "My Dashboard", "type": "manual_dashboard_list" } ``` {% /tab %} {% /tab %} {% tab title="400" %} Bad Request {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="403" %} Forbidden {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} Error response object. | Field | Type | Description | | ------------------------ | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \## default # \# Curl command curl -X POST "https://api.datadoghq.com/api/v1/dashboard/lists/manual" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \ -d @- << EOF { "name": "My Dashboard List" } EOF ##### ```go // Create a dashboard list returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV1" ) func main() { body := datadogV1.DashboardList{ Name: "Example-Dashboard-List", } ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV1.NewDashboardListsApi(apiClient) resp, r, err := api.CreateDashboardList(ctx, body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DashboardListsApi.CreateDashboardList`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `DashboardListsApi.CreateDashboardList`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Create a dashboard list returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v1.api.DashboardListsApi; import com.datadog.api.client.v1.model.DashboardList; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); DashboardListsApi apiInstance = new DashboardListsApi(defaultClient); DashboardList body = new DashboardList().name("Example-Dashboard-List"); try { DashboardList result = apiInstance.createDashboardList(body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling DashboardListsApi#createDashboardList"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```python from datadog import initialize, api options = { 'api_key': '', 'app_key': '' } initialize(**options) name = 'My Dashboard List' api.DashboardList.create(name=name) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python-legacy) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" python "example.py" ##### ```python """ Create a dashboard list returns "OK" response """ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v1.api.dashboard_lists_api import DashboardListsApi from datadog_api_client.v1.model.dashboard_list import DashboardList body = DashboardList( name="Example-Dashboard-List", ) configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = DashboardListsApi(api_client) response = api_instance.create_dashboard_list(body=body) print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby require 'rubygems' require 'dogapi' api_key = '' app_key = '' dog = Dogapi::Client.new(api_key, app_key) name = 'My Dashboard List' result = dog.create_dashboard_list(name) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby-legacy) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```ruby # Create a dashboard list returns "OK" response require "datadog_api_client" api_instance = DatadogAPIClient::V1::DashboardListsAPI.new body = DatadogAPIClient::V1::DashboardList.new({ name: "Example-Dashboard-List", }) p api_instance.create_dashboard_list(body) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```rust // Create a dashboard list returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV1::api_dashboard_lists::DashboardListsAPI; use datadog_api_client::datadogV1::model::DashboardList; #[tokio::main] async fn main() { let body = DashboardList::new("Example-Dashboard-List".to_string()); let configuration = datadog::Configuration::new(); let api = DashboardListsAPI::with_config(configuration); let resp = api.create_dashboard_list(body).await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Create a dashboard list returns "OK" response */ import { client, v1 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v1.DashboardListsApi(configuration); const params: v1.DashboardListsApiCreateDashboardListRequest = { body: { name: "Example-Dashboard-List", }, }; apiInstance .createDashboardList(params) .then((data: v1.DashboardList) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %}