docs/v1/README.md in datadog_api_client-1.2.0 vs docs/v1/README.md in datadog_api_client-1.3.0

- old
+ new

@@ -58,12 +58,14 @@ *DatadogAPIClient::V1::DashboardListsAPI* | [**get_dashboard_list**](DashboardListsAPI.md#get_dashboard_list) | **GET** /api/v1/dashboard/lists/manual/{list_id} | Get a dashboard list *DatadogAPIClient::V1::DashboardListsAPI* | [**list_dashboard_lists**](DashboardListsAPI.md#list_dashboard_lists) | **GET** /api/v1/dashboard/lists/manual | Get all dashboard lists *DatadogAPIClient::V1::DashboardListsAPI* | [**update_dashboard_list**](DashboardListsAPI.md#update_dashboard_list) | **PUT** /api/v1/dashboard/lists/manual/{list_id} | Update a dashboard list *DatadogAPIClient::V1::DashboardsAPI* | [**create_dashboard**](DashboardsAPI.md#create_dashboard) | **POST** /api/v1/dashboard | Create a new dashboard *DatadogAPIClient::V1::DashboardsAPI* | [**delete_dashboard**](DashboardsAPI.md#delete_dashboard) | **DELETE** /api/v1/dashboard/{dashboard_id} | Delete a dashboard +*DatadogAPIClient::V1::DashboardsAPI* | [**delete_dashboards**](DashboardsAPI.md#delete_dashboards) | **DELETE** /api/v1/dashboard | Delete dashboards *DatadogAPIClient::V1::DashboardsAPI* | [**get_dashboard**](DashboardsAPI.md#get_dashboard) | **GET** /api/v1/dashboard/{dashboard_id} | Get a dashboard *DatadogAPIClient::V1::DashboardsAPI* | [**list_dashboards**](DashboardsAPI.md#list_dashboards) | **GET** /api/v1/dashboard | Get all dashboards +*DatadogAPIClient::V1::DashboardsAPI* | [**restore_dashboards**](DashboardsAPI.md#restore_dashboards) | **PATCH** /api/v1/dashboard | Restore deleted dashboards *DatadogAPIClient::V1::DashboardsAPI* | [**update_dashboard**](DashboardsAPI.md#update_dashboard) | **PUT** /api/v1/dashboard/{dashboard_id} | Update a dashboard *DatadogAPIClient::V1::DowntimesAPI* | [**cancel_downtime**](DowntimesAPI.md#cancel_downtime) | **DELETE** /api/v1/downtime/{downtime_id} | Cancel a downtime *DatadogAPIClient::V1::DowntimesAPI* | [**cancel_downtimes_by_scope**](DowntimesAPI.md#cancel_downtimes_by_scope) | **POST** /api/v1/downtime/cancel/by_scope | Cancel downtimes by scope *DatadogAPIClient::V1::DowntimesAPI* | [**create_downtime**](DowntimesAPI.md#create_downtime) | **POST** /api/v1/downtime | Schedule a downtime *DatadogAPIClient::V1::DowntimesAPI* | [**get_downtime**](DowntimesAPI.md#get_downtime) | **GET** /api/v1/downtime/{downtime_id} | Get a downtime @@ -196,10 +198,11 @@ *DatadogAPIClient::V1::UsageMeteringAPI* | [**get_usage_attribution**](UsageMeteringAPI.md#get_usage_attribution) | **GET** /api/v1/usage/attribution | Get Usage Attribution *DatadogAPIClient::V1::UsageMeteringAPI* | [**get_usage_audit_logs**](UsageMeteringAPI.md#get_usage_audit_logs) | **GET** /api/v1/usage/audit_logs | Get hourly usage for audit logs *DatadogAPIClient::V1::UsageMeteringAPI* | [**get_usage_billable_summary**](UsageMeteringAPI.md#get_usage_billable_summary) | **GET** /api/v1/usage/billable-summary | Get billable usage across your account *DatadogAPIClient::V1::UsageMeteringAPI* | [**get_usage_cloud_security_posture_management**](UsageMeteringAPI.md#get_usage_cloud_security_posture_management) | **GET** /api/v1/usage/cspm | Get hourly usage for CSPM *DatadogAPIClient::V1::UsageMeteringAPI* | [**get_usage_cws**](UsageMeteringAPI.md#get_usage_cws) | **GET** /api/v1/usage/cws | Get hourly usage for Cloud Workload Security +*DatadogAPIClient::V1::UsageMeteringAPI* | [**get_usage_dbm**](UsageMeteringAPI.md#get_usage_dbm) | **GET** /api/v1/usage/dbm | Get hourly usage for Database Monitoring *DatadogAPIClient::V1::UsageMeteringAPI* | [**get_usage_fargate**](UsageMeteringAPI.md#get_usage_fargate) | **GET** /api/v1/usage/fargate | Get hourly usage for Fargate *DatadogAPIClient::V1::UsageMeteringAPI* | [**get_usage_hosts**](UsageMeteringAPI.md#get_usage_hosts) | **GET** /api/v1/usage/hosts | Get hourly usage for hosts and containers *DatadogAPIClient::V1::UsageMeteringAPI* | [**get_usage_indexed_spans**](UsageMeteringAPI.md#get_usage_indexed_spans) | **GET** /api/v1/usage/indexed-spans | Get hourly usage for indexed spans *DatadogAPIClient::V1::UsageMeteringAPI* | [**get_usage_internet_of_things**](UsageMeteringAPI.md#get_usage_internet_of_things) | **GET** /api/v1/usage/iot | Get hourly usage for IoT *DatadogAPIClient::V1::UsageMeteringAPI* | [**get_usage_lambda**](UsageMeteringAPI.md#get_usage_lambda) | **GET** /api/v1/usage/aws_lambda | Get hourly usage for Lambda @@ -220,10 +223,18 @@ *DatadogAPIClient::V1::UsersAPI* | [**create_user**](UsersAPI.md#create_user) | **POST** /api/v1/user | Create a user *DatadogAPIClient::V1::UsersAPI* | [**disable_user**](UsersAPI.md#disable_user) | **DELETE** /api/v1/user/{user_handle} | Disable a user *DatadogAPIClient::V1::UsersAPI* | [**get_user**](UsersAPI.md#get_user) | **GET** /api/v1/user/{user_handle} | Get user details *DatadogAPIClient::V1::UsersAPI* | [**list_users**](UsersAPI.md#list_users) | **GET** /api/v1/user | List all users *DatadogAPIClient::V1::UsersAPI* | [**update_user**](UsersAPI.md#update_user) | **PUT** /api/v1/user/{user_handle} | Update a user +*DatadogAPIClient::V1::WebhooksIntegrationAPI* | [**create_webhooks_integration**](WebhooksIntegrationAPI.md#create_webhooks_integration) | **POST** /api/v1/integration/webhooks/configuration/webhooks | Create a webhooks integration +*DatadogAPIClient::V1::WebhooksIntegrationAPI* | [**create_webhooks_integration_custom_variable**](WebhooksIntegrationAPI.md#create_webhooks_integration_custom_variable) | **POST** /api/v1/integration/webhooks/configuration/custom-variables | Create a custom variable +*DatadogAPIClient::V1::WebhooksIntegrationAPI* | [**delete_webhooks_integration**](WebhooksIntegrationAPI.md#delete_webhooks_integration) | **DELETE** /api/v1/integration/webhooks/configuration/webhooks/{webhook_name} | Delete a webhook +*DatadogAPIClient::V1::WebhooksIntegrationAPI* | [**delete_webhooks_integration_custom_variable**](WebhooksIntegrationAPI.md#delete_webhooks_integration_custom_variable) | **DELETE** /api/v1/integration/webhooks/configuration/custom-variables/{custom_variable_name} | Delete a custom variable +*DatadogAPIClient::V1::WebhooksIntegrationAPI* | [**get_webhooks_integration**](WebhooksIntegrationAPI.md#get_webhooks_integration) | **GET** /api/v1/integration/webhooks/configuration/webhooks/{webhook_name} | Get a webhook integration +*DatadogAPIClient::V1::WebhooksIntegrationAPI* | [**get_webhooks_integration_custom_variable**](WebhooksIntegrationAPI.md#get_webhooks_integration_custom_variable) | **GET** /api/v1/integration/webhooks/configuration/custom-variables/{custom_variable_name} | Get a custom variable +*DatadogAPIClient::V1::WebhooksIntegrationAPI* | [**update_webhooks_integration**](WebhooksIntegrationAPI.md#update_webhooks_integration) | **PUT** /api/v1/integration/webhooks/configuration/webhooks/{webhook_name} | Update a webhook +*DatadogAPIClient::V1::WebhooksIntegrationAPI* | [**update_webhooks_integration_custom_variable**](WebhooksIntegrationAPI.md#update_webhooks_integration_custom_variable) | **PUT** /api/v1/integration/webhooks/configuration/custom-variables/{custom_variable_name} | Update a custom variable ## Documentation for Models - [DatadogAPIClient::V1::APIErrorResponse](APIErrorResponse.md) @@ -271,16 +282,20 @@ - [DatadogAPIClient::V1::CheckStatusWidgetDefinition](CheckStatusWidgetDefinition.md) - [DatadogAPIClient::V1::CheckStatusWidgetDefinitionType](CheckStatusWidgetDefinitionType.md) - [DatadogAPIClient::V1::ContentEncoding](ContentEncoding.md) - [DatadogAPIClient::V1::Creator](Creator.md) - [DatadogAPIClient::V1::Dashboard](Dashboard.md) + - [DatadogAPIClient::V1::DashboardBulkActionData](DashboardBulkActionData.md) + - [DatadogAPIClient::V1::DashboardBulkDeleteRequest](DashboardBulkDeleteRequest.md) - [DatadogAPIClient::V1::DashboardDeleteResponse](DashboardDeleteResponse.md) - [DatadogAPIClient::V1::DashboardLayoutType](DashboardLayoutType.md) - [DatadogAPIClient::V1::DashboardList](DashboardList.md) - [DatadogAPIClient::V1::DashboardListDeleteResponse](DashboardListDeleteResponse.md) - [DatadogAPIClient::V1::DashboardListListResponse](DashboardListListResponse.md) - [DatadogAPIClient::V1::DashboardReflowType](DashboardReflowType.md) + - [DatadogAPIClient::V1::DashboardResourceType](DashboardResourceType.md) + - [DatadogAPIClient::V1::DashboardRestoreRequest](DashboardRestoreRequest.md) - [DatadogAPIClient::V1::DashboardSummary](DashboardSummary.md) - [DatadogAPIClient::V1::DashboardSummaryDefinition](DashboardSummaryDefinition.md) - [DatadogAPIClient::V1::DashboardTemplateVariable](DashboardTemplateVariable.md) - [DatadogAPIClient::V1::DashboardTemplateVariablePreset](DashboardTemplateVariablePreset.md) - [DatadogAPIClient::V1::DashboardTemplateVariablePresetValue](DashboardTemplateVariablePresetValue.md) @@ -362,10 +377,18 @@ - [DatadogAPIClient::V1::IdpFormData](IdpFormData.md) - [DatadogAPIClient::V1::IdpResponse](IdpResponse.md) - [DatadogAPIClient::V1::ImageWidgetDefinition](ImageWidgetDefinition.md) - [DatadogAPIClient::V1::ImageWidgetDefinitionType](ImageWidgetDefinitionType.md) - [DatadogAPIClient::V1::IntakePayloadAccepted](IntakePayloadAccepted.md) + - [DatadogAPIClient::V1::ListStreamColumn](ListStreamColumn.md) + - [DatadogAPIClient::V1::ListStreamColumnWidth](ListStreamColumnWidth.md) + - [DatadogAPIClient::V1::ListStreamQuery](ListStreamQuery.md) + - [DatadogAPIClient::V1::ListStreamResponseFormat](ListStreamResponseFormat.md) + - [DatadogAPIClient::V1::ListStreamSource](ListStreamSource.md) + - [DatadogAPIClient::V1::ListStreamWidgetDefinition](ListStreamWidgetDefinition.md) + - [DatadogAPIClient::V1::ListStreamWidgetDefinitionType](ListStreamWidgetDefinitionType.md) + - [DatadogAPIClient::V1::ListStreamWidgetRequest](ListStreamWidgetRequest.md) - [DatadogAPIClient::V1::Log](Log.md) - [DatadogAPIClient::V1::LogContent](LogContent.md) - [DatadogAPIClient::V1::LogQueryDefinition](LogQueryDefinition.md) - [DatadogAPIClient::V1::LogQueryDefinitionGroupBy](LogQueryDefinitionGroupBy.md) - [DatadogAPIClient::V1::LogQueryDefinitionGroupBySort](LogQueryDefinitionGroupBySort.md) @@ -538,13 +561,15 @@ - [DatadogAPIClient::V1::SLOErrorTimeframe](SLOErrorTimeframe.md) - [DatadogAPIClient::V1::SLOHistoryMetrics](SLOHistoryMetrics.md) - [DatadogAPIClient::V1::SLOHistoryMetricsSeries](SLOHistoryMetricsSeries.md) - [DatadogAPIClient::V1::SLOHistoryMetricsSeriesMetadata](SLOHistoryMetricsSeriesMetadata.md) - [DatadogAPIClient::V1::SLOHistoryMetricsSeriesMetadataUnit](SLOHistoryMetricsSeriesMetadataUnit.md) + - [DatadogAPIClient::V1::SLOHistoryMonitor](SLOHistoryMonitor.md) - [DatadogAPIClient::V1::SLOHistoryResponse](SLOHistoryResponse.md) - [DatadogAPIClient::V1::SLOHistoryResponseData](SLOHistoryResponseData.md) - [DatadogAPIClient::V1::SLOHistoryResponseError](SLOHistoryResponseError.md) + - [DatadogAPIClient::V1::SLOHistoryResponseErrorWithType](SLOHistoryResponseErrorWithType.md) - [DatadogAPIClient::V1::SLOHistorySLIData](SLOHistorySLIData.md) - [DatadogAPIClient::V1::SLOListResponse](SLOListResponse.md) - [DatadogAPIClient::V1::SLOListResponseMetadata](SLOListResponseMetadata.md) - [DatadogAPIClient::V1::SLOListResponseMetadataPage](SLOListResponseMetadataPage.md) - [DatadogAPIClient::V1::SLOResponse](SLOResponse.md) @@ -557,10 +582,11 @@ - [DatadogAPIClient::V1::SLOWidgetDefinitionType](SLOWidgetDefinitionType.md) - [DatadogAPIClient::V1::ScatterPlotRequest](ScatterPlotRequest.md) - [DatadogAPIClient::V1::ScatterPlotWidgetDefinition](ScatterPlotWidgetDefinition.md) - [DatadogAPIClient::V1::ScatterPlotWidgetDefinitionRequests](ScatterPlotWidgetDefinitionRequests.md) - [DatadogAPIClient::V1::ScatterPlotWidgetDefinitionType](ScatterPlotWidgetDefinitionType.md) + - [DatadogAPIClient::V1::ScatterplotWidgetAggregator](ScatterplotWidgetAggregator.md) - [DatadogAPIClient::V1::Series](Series.md) - [DatadogAPIClient::V1::ServiceCheck](ServiceCheck.md) - [DatadogAPIClient::V1::ServiceCheckStatus](ServiceCheckStatus.md) - [DatadogAPIClient::V1::ServiceLevelObjective](ServiceLevelObjective.md) - [DatadogAPIClient::V1::ServiceLevelObjectiveQuery](ServiceLevelObjectiveQuery.md) @@ -617,10 +643,11 @@ - [DatadogAPIClient::V1::SyntheticsDeviceID](SyntheticsDeviceID.md) - [DatadogAPIClient::V1::SyntheticsErrorCode](SyntheticsErrorCode.md) - [DatadogAPIClient::V1::SyntheticsGetAPITestLatestResultsResponse](SyntheticsGetAPITestLatestResultsResponse.md) - [DatadogAPIClient::V1::SyntheticsGetBrowserTestLatestResultsResponse](SyntheticsGetBrowserTestLatestResultsResponse.md) - [DatadogAPIClient::V1::SyntheticsGlobalVariable](SyntheticsGlobalVariable.md) + - [DatadogAPIClient::V1::SyntheticsGlobalVariableAttributes](SyntheticsGlobalVariableAttributes.md) - [DatadogAPIClient::V1::SyntheticsGlobalVariableParseTestOptions](SyntheticsGlobalVariableParseTestOptions.md) - [DatadogAPIClient::V1::SyntheticsGlobalVariableParseTestOptionsType](SyntheticsGlobalVariableParseTestOptionsType.md) - [DatadogAPIClient::V1::SyntheticsGlobalVariableParserType](SyntheticsGlobalVariableParserType.md) - [DatadogAPIClient::V1::SyntheticsGlobalVariableValue](SyntheticsGlobalVariableValue.md) - [DatadogAPIClient::V1::SyntheticsListGlobalVariablesResponse](SyntheticsListGlobalVariablesResponse.md) @@ -707,10 +734,12 @@ - [DatadogAPIClient::V1::UsageCustomReportsAttributes](UsageCustomReportsAttributes.md) - [DatadogAPIClient::V1::UsageCustomReportsData](UsageCustomReportsData.md) - [DatadogAPIClient::V1::UsageCustomReportsMeta](UsageCustomReportsMeta.md) - [DatadogAPIClient::V1::UsageCustomReportsPage](UsageCustomReportsPage.md) - [DatadogAPIClient::V1::UsageCustomReportsResponse](UsageCustomReportsResponse.md) + - [DatadogAPIClient::V1::UsageDBMHour](UsageDBMHour.md) + - [DatadogAPIClient::V1::UsageDBMResponse](UsageDBMResponse.md) - [DatadogAPIClient::V1::UsageFargateHour](UsageFargateHour.md) - [DatadogAPIClient::V1::UsageFargateResponse](UsageFargateResponse.md) - [DatadogAPIClient::V1::UsageHostHour](UsageHostHour.md) - [DatadogAPIClient::V1::UsageHostsResponse](UsageHostsResponse.md) - [DatadogAPIClient::V1::UsageIncidentManagementHour](UsageIncidentManagementHour.md) @@ -764,10 +793,16 @@ - [DatadogAPIClient::V1::UsageTopAvgMetricsResponse](UsageTopAvgMetricsResponse.md) - [DatadogAPIClient::V1::User](User.md) - [DatadogAPIClient::V1::UserDisableResponse](UserDisableResponse.md) - [DatadogAPIClient::V1::UserListResponse](UserListResponse.md) - [DatadogAPIClient::V1::UserResponse](UserResponse.md) + - [DatadogAPIClient::V1::WebhooksIntegration](WebhooksIntegration.md) + - [DatadogAPIClient::V1::WebhooksIntegrationCustomVariable](WebhooksIntegrationCustomVariable.md) + - [DatadogAPIClient::V1::WebhooksIntegrationCustomVariableResponse](WebhooksIntegrationCustomVariableResponse.md) + - [DatadogAPIClient::V1::WebhooksIntegrationCustomVariableUpdateRequest](WebhooksIntegrationCustomVariableUpdateRequest.md) + - [DatadogAPIClient::V1::WebhooksIntegrationEncoding](WebhooksIntegrationEncoding.md) + - [DatadogAPIClient::V1::WebhooksIntegrationUpdateRequest](WebhooksIntegrationUpdateRequest.md) - [DatadogAPIClient::V1::Widget](Widget.md) - [DatadogAPIClient::V1::WidgetAggregator](WidgetAggregator.md) - [DatadogAPIClient::V1::WidgetAxis](WidgetAxis.md) - [DatadogAPIClient::V1::WidgetChangeType](WidgetChangeType.md) - [DatadogAPIClient::V1::WidgetColorPreference](WidgetColorPreference.md) @@ -813,9 +848,34 @@ - [DatadogAPIClient::V1::WidgetVizType](WidgetVizType.md) ## Documentation for Authorization + +### AuthZ + + +- **Type**: OAuth +- **Flow**: accessCode +- **Authorization URL**: /oauth2/v1/authorize +- **Scopes**: + - dashboards_public_share: The ability to share dashboards externally. + - dashboards_read: The ability to view dashboards. + - dashboards_write: The ability to create and change dashboards. + - events_read: The ability to read events data. + - metrics_read: The ability to view custom metrics. + - monitors_downtime: The ability to set downtimes for your organization. A user with this permission can suppress alerts from any monitor using a downtime, even if they do not have permission to edit those monitors explicitly. + - monitors_read: The ability to view monitors. + - monitors_write: The ability to change, mute, and delete individual monitors. + - synthetics_global_variable_read: The ability to view, search and use in tests the list of global variables available for Synthetics. + - synthetics_global_variable_write: The ability to create, edit, and delete global variables for Synthetics. + - synthetics_private_location_read: The ability to view, search and use in tests the list of private locations available. + - synthetics_read: The ability to list and view configured Synthetic tests. + - synthetics_write: The ability to create, edit, and delete Synthetic tests. + - timeseries_query: The ability to query timeseries data. + - usage_read: The ability to view your organization's usage and usage attribution. + - user_access_invite: Allows users to invite other users to your organization. + - user_access_manage: Grants the permission to disable users, manage user roles and SAML-to-role mappings. ### apiKeyAuth - **Type**: API key