--- title: Get all dashboards description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Dashboards --- # Get all dashboards{% #get-all-dashboards %} Copy pageCopied {% tab title="v1" %} | Datadog site | API endpoint | | ----------------- | -------------------------------------------------- | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v1/dashboard | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v1/dashboard | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v1/dashboard | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v1/dashboard | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v1/dashboard | | app.datadoghq.com | GET https://api.datadoghq.com/api/v1/dashboard | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v1/dashboard | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v1/dashboard | ### Overview Get all dashboards. **Note**: This query will only return custom created or cloned dashboards. This query will not return preset dashboards. This endpoint requires the `dashboards_read` permission. OAuth apps require the `dashboards_read` authorization [scope](https://docs.datadoghq.com/api/latest/scopes.md#dashboards) to access this endpoint. ### Arguments #### Query Strings | Name | Type | Description | | --------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- | | filter[shared] | boolean | When `true`, this query only returns shared custom created or cloned dashboards. | | filter[deleted] | boolean | When `true`, this query returns only deleted custom-created or cloned dashboards. This parameter is incompatible with `filter[shared]`. | | count | integer | The maximum number of dashboards returned in the list. | | start | integer | The specific offset to use as the beginning of the returned response. | ### Response {% tab title="200" %} OK {% tab title="Model" %} Dashboard summary response. | Parent field | Field | Type | Description | | ------------ | ------------- | --------- | ---------------------------------------------------------------------------------------------------------------- | | | dashboards | [object] | List of dashboard definitions. | | dashboards | author_handle | string | Identifier of the dashboard author. | | dashboards | created_at | date-time | Creation date of the dashboard. | | dashboards | description | string | Description of the dashboard. | | dashboards | id | string | Dashboard identifier. | | dashboards | is_read_only | boolean | **DEPRECATED**: Whether this dashboard is read-only. If True, only the author and admins can make changes to it. | This property is deprecated; please use the [Restriction Policies API](https://docs.datadoghq.com/api/latest/restriction-policies.md) instead to manage write authorization for individual dashboards. | | dashboards | layout_type | enum | Layout type of the dashboard. Allowed enum values: `ordered,free` | | dashboards | modified_at | date-time | Modification date of the dashboard. | | dashboards | title | string | Title of the dashboard. | | dashboards | url | string | URL of the dashboard. | {% /tab %} {% tab title="Example" %} ```json { "dashboards": [ { "author_handle": "string", "created_at": "2019-09-19T10:00:00.000Z", "description": "string", "id": "string", "is_read_only": false, "layout_type": "ordered", "modified_at": "2019-09-19T10:00:00.000Z", "title": "string", "url": "string" } ] } ``` {% /tab %} {% /tab %} {% tab title="403" %} Authentication Error {% 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 ##### \# Curl command curl -X GET "https://api.datadoghq.com/api/v1/dashboard" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" ##### ```python """ Get all dashboards returns "OK" response """ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v1.api.dashboards_api import DashboardsApi configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = DashboardsApi(api_client) response = api_instance.list_dashboards( filter_shared=False, ) 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 # Get all dashboards returns "OK" response require "datadog_api_client" api_instance = DatadogAPIClient::V1::DashboardsAPI.new opts = { filter_shared: false, } p api_instance.list_dashboards(opts) ``` #### 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" ##### ```ruby require 'rubygems' require 'dogapi' api_key = '' app_key = '' dog = Dogapi::Client.new(api_key, app_key) dog.get_all_boards() ``` #### 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" ##### ```go // Get all dashboards 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() { ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV1.NewDashboardsApi(apiClient) resp, r, err := api.ListDashboards(ctx, *datadogV1.NewListDashboardsOptionalParameters().WithFilterShared(false)) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `DashboardsApi.ListDashboards`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `DashboardsApi.ListDashboards`:\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 // Get all dashboards returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v1.api.DashboardsApi; import com.datadog.api.client.v1.api.DashboardsApi.ListDashboardsOptionalParameters; import com.datadog.api.client.v1.model.DashboardSummary; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); DashboardsApi apiInstance = new DashboardsApi(defaultClient); try { DashboardSummary result = apiInstance.listDashboards(new ListDashboardsOptionalParameters().filterShared(false)); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling DashboardsApi#listDashboards"); 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) api.Dashboard.get_all() ``` #### 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" ##### ```rust // Get all dashboards returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV1::api_dashboards::DashboardsAPI; use datadog_api_client::datadogV1::api_dashboards::ListDashboardsOptionalParams; #[tokio::main] async fn main() { let configuration = datadog::Configuration::new(); let api = DashboardsAPI::with_config(configuration); let resp = api .list_dashboards(ListDashboardsOptionalParams::default().filter_shared(false)) .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 /** * Get all dashboards returns "OK" response */ import { client, v1 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v1.DashboardsApi(configuration); const params: v1.DashboardsApiListDashboardsRequest = { filterShared: false, }; apiInstance .listDashboards(params) .then((data: v1.DashboardSummary) => { 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 %}