docs/v1/DashboardsAPI.md in datadog_api_client-1.4.0 vs docs/v1/DashboardsAPI.md in datadog_api_client-1.5.0
- old
+ new
@@ -1,20 +1,19 @@
# DatadogAPIClient::V1::DashboardsAPI
All URIs are relative to *https://api.datadoghq.com*
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**create_dashboard**](DashboardsAPI.md#create_dashboard) | **POST** /api/v1/dashboard | Create a new dashboard |
-| [**delete_dashboard**](DashboardsAPI.md#delete_dashboard) | **DELETE** /api/v1/dashboard/{dashboard_id} | Delete a dashboard |
-| [**delete_dashboards**](DashboardsAPI.md#delete_dashboards) | **DELETE** /api/v1/dashboard | Delete dashboards |
-| [**get_dashboard**](DashboardsAPI.md#get_dashboard) | **GET** /api/v1/dashboard/{dashboard_id} | Get a dashboard |
-| [**list_dashboards**](DashboardsAPI.md#list_dashboards) | **GET** /api/v1/dashboard | Get all dashboards |
-| [**restore_dashboards**](DashboardsAPI.md#restore_dashboards) | **PATCH** /api/v1/dashboard | Restore deleted dashboards |
-| [**update_dashboard**](DashboardsAPI.md#update_dashboard) | **PUT** /api/v1/dashboard/{dashboard_id} | Update a dashboard |
+| Method | HTTP request | Description |
+| ------------------------------------------------------------- | ------------------------------------------- | -------------------------- |
+| [**create_dashboard**](DashboardsAPI.md#create_dashboard) | **POST** /api/v1/dashboard | Create a new dashboard |
+| [**delete_dashboard**](DashboardsAPI.md#delete_dashboard) | **DELETE** /api/v1/dashboard/{dashboard_id} | Delete a dashboard |
+| [**delete_dashboards**](DashboardsAPI.md#delete_dashboards) | **DELETE** /api/v1/dashboard | Delete dashboards |
+| [**get_dashboard**](DashboardsAPI.md#get_dashboard) | **GET** /api/v1/dashboard/{dashboard_id} | Get a dashboard |
+| [**list_dashboards**](DashboardsAPI.md#list_dashboards) | **GET** /api/v1/dashboard | Get all dashboards |
+| [**restore_dashboards**](DashboardsAPI.md#restore_dashboards) | **PATCH** /api/v1/dashboard | Restore deleted dashboards |
+| [**update_dashboard**](DashboardsAPI.md#update_dashboard) | **PUT** /api/v1/dashboard/{dashboard_id} | Update a dashboard |
-
## create_dashboard
> <Dashboard> create_dashboard(body)
Create a dashboard using the specified options. When defining queries in your widgets, take note of which queries should have the `as_count()` or `as_rate()` modifiers appended.
@@ -54,13 +53,13 @@
end
```
### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **body** | [**Dashboard**](Dashboard.md) | Create a dashboard request body. | |
+| Name | Type | Description | Notes |
+| -------- | ----------------------------- | -------------------------------- | ----- |
+| **body** | [**Dashboard**](Dashboard.md) | Create a dashboard request body. | |
### Return type
[**Dashboard**](Dashboard.md)
@@ -71,11 +70,10 @@
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
-
## delete_dashboard
> <DashboardDeleteResponse> delete_dashboard(dashboard_id)
Delete a dashboard using the specified ID.
@@ -114,13 +112,13 @@
end
```
### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **dashboard_id** | **String** | The ID of the dashboard. | |
+| Name | Type | Description | Notes |
+| ---------------- | ---------- | ------------------------ | ----- |
+| **dashboard_id** | **String** | The ID of the dashboard. | |
### Return type
[**DashboardDeleteResponse**](DashboardDeleteResponse.md)
@@ -131,11 +129,10 @@
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
-
## delete_dashboards
> delete_dashboards(body)
Delete dashboards using the specified IDs. If there are any failures, no dashboards will be deleted (partial success is not allowed).
@@ -173,13 +170,13 @@
end
```
### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **body** | [**DashboardBulkDeleteRequest**](DashboardBulkDeleteRequest.md) | Delete dashboards request body. | |
+| Name | Type | Description | Notes |
+| -------- | --------------------------------------------------------------- | ------------------------------- | ----- |
+| **body** | [**DashboardBulkDeleteRequest**](DashboardBulkDeleteRequest.md) | Delete dashboards request body. | |
### Return type
nil (empty response body)
@@ -190,11 +187,10 @@
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
-
## get_dashboard
> <Dashboard> get_dashboard(dashboard_id)
Get a dashboard using the specified ID.
@@ -233,13 +229,13 @@
end
```
### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **dashboard_id** | **String** | The ID of the dashboard. | |
+| Name | Type | Description | Notes |
+| ---------------- | ---------- | ------------------------ | ----- |
+| **dashboard_id** | **String** | The ID of the dashboard. | |
### Return type
[**Dashboard**](Dashboard.md)
@@ -250,11 +246,10 @@
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
-
## list_dashboards
> <DashboardSummary> list_dashboards(opts)
Get all dashboards.
@@ -298,12 +293,12 @@
end
```
### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
+| Name | Type | Description | Notes |
+| ----------------- | ----------- | ------------------------------------------------------------------------------------------ | ---------- |
| **filter_shared** | **Boolean** | When `true`, this query only returns shared custom created or cloned dashboards. | [optional] |
### Return type
[**DashboardSummary**](DashboardSummary.md)
@@ -315,11 +310,10 @@
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
-
## restore_dashboards
> restore_dashboards(body)
Restore dashboards using the specified IDs. If there are any failures, no dashboards will be restored (partial success is not allowed).
@@ -357,13 +351,13 @@
end
```
### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **body** | [**DashboardRestoreRequest**](DashboardRestoreRequest.md) | Restore dashboards request body. | |
+| Name | Type | Description | Notes |
+| -------- | --------------------------------------------------------- | -------------------------------- | ----- |
+| **body** | [**DashboardRestoreRequest**](DashboardRestoreRequest.md) | Restore dashboards request body. | |
### Return type
nil (empty response body)
@@ -374,11 +368,10 @@
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
-
## update_dashboard
> <Dashboard> update_dashboard(dashboard_id, body)
Update a dashboard using the specified ID.
@@ -418,14 +411,14 @@
end
```
### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **dashboard_id** | **String** | The ID of the dashboard. | |
-| **body** | [**Dashboard**](Dashboard.md) | Update Dashboard request body. | |
+| Name | Type | Description | Notes |
+| ---------------- | ----------------------------- | ------------------------------ | ----- |
+| **dashboard_id** | **String** | The ID of the dashboard. | |
+| **body** | [**Dashboard**](Dashboard.md) | Update Dashboard request body. | |
### Return type
[**Dashboard**](Dashboard.md)
@@ -435,6 +428,5 @@
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
-