diff --git a/.apigentools-info b/.apigentools-info index 035a467e627b..e3c426e08657 100644 --- a/.apigentools-info +++ b/.apigentools-info @@ -4,13 +4,13 @@ "spec_versions": { "v1": { "apigentools_version": "1.5.1.dev2", - "regenerated": "2021-10-27 09:02:32.043203", - "spec_repo_commit": "5f2ff0f" + "regenerated": "2021-10-27 12:50:06.114952", + "spec_repo_commit": "0b58986" }, "v2": { "apigentools_version": "1.5.1.dev2", - "regenerated": "2021-10-27 09:02:32.072483", - "spec_repo_commit": "5f2ff0f" + "regenerated": "2021-10-27 12:50:06.145709", + "spec_repo_commit": "0b58986" } } } \ No newline at end of file diff --git a/.generator/schemas/v1/openapi.yaml b/.generator/schemas/v1/openapi.yaml index 6e2304eb2982..62bc08821a5f 100644 --- a/.generator/schemas/v1/openapi.yaml +++ b/.generator/schemas/v1/openapi.yaml @@ -907,8 +907,10 @@ components: type: string is_read_only: default: false + deprecated: true description: Whether this dashboard is read-only. If True, only the author - and admins can make changes to it. + and admins can make changes to it. Prefer using `restricted_roles` to + manage write authorization. example: false type: boolean layout_type: @@ -930,9 +932,7 @@ components: $ref: '#/components/schemas/DashboardReflowType' restricted_roles: description: A list of role identifiers. Only the author and users associated - with at least one of these roles can edit this dashboard. Overrides the - `is_read_only` property if both are present. **This feature is currently - in beta.** + with at least one of these roles can edit this dashboard. items: description: A role UUID. type: string diff --git a/docs/v1/APIErrorResponse.md b/docs/v1/APIErrorResponse.md index bd0e9cd61a9d..73f0d6585333 100644 --- a/docs/v1/APIErrorResponse.md +++ b/docs/v1/APIErrorResponse.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **errors** | **Array<String>** | Array of errors returned by the API. | | +| Name | Type | Description | Notes | +| ---------- | ----------------------- | ------------------------------------ | ----- | +| **errors** | **Array<String>** | Array of errors returned by the API. | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::APIErrorResponse.new( errors: null ) ``` - diff --git a/docs/v1/AWSAccount.md b/docs/v1/AWSAccount.md index b51da59c9ad6..51a3c20986e2 100644 --- a/docs/v1/AWSAccount.md +++ b/docs/v1/AWSAccount.md @@ -2,19 +2,19 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **access_key_id** | **String** | Your AWS access key ID. Only required if your AWS account is a GovCloud or China account. | [optional] | -| **account_id** | **String** | Your AWS Account ID without dashes. | [optional] | -| **account_specific_namespace_rules** | **Hash<String, Boolean>** | An object, (in the form `{\"namespace1\":true/false, \"namespace2\":true/false}`), that enables or disables metric collection for specific AWS namespaces for this AWS account only. | [optional] | -| **cspm_resource_collection_enabled** | **Boolean** | Whether Datadog collects cloud security posture management resources from your AWS account. This includes additional resources not covered under the general `resource_collection`. | [optional][default to false] | -| **excluded_regions** | **Array<String>** | An array of AWS regions to exclude from metrics collection. | [optional] | -| **filter_tags** | **Array<String>** | The array of EC2 tags (in the form `key:value`) defines a filter that Datadog uses when collecting metrics from EC2. Wildcards, such as `?` (for single characters) and `*` (for multiple characters) can also be used. Only hosts that match one of the defined tags will be imported into Datadog. The rest will be ignored. Host matching a given tag can also be excluded by adding `!` before the tag. For example, `env:production,instance-type:c1.*,!region:us-east-1` | [optional] | -| **host_tags** | **Array<String>** | Array of tags (in the form `key:value`) to add to all hosts and metrics reporting through this integration. | [optional] | -| **metrics_collection_enabled** | **Boolean** | Whether Datadog collects metrics for this AWS account. | [optional][default to true] | -| **resource_collection_enabled** | **Boolean** | Whether Datadog collects a standard set of resources from your AWS account. | [optional][default to false] | -| **role_name** | **String** | Your Datadog role delegation name. | [optional] | -| **secret_access_key** | **String** | Your AWS secret access key. Only required if your AWS account is a GovCloud or China account. | [optional] | +| Name | Type | Description | Notes | +| ------------------------------------ | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | +| **access_key_id** | **String** | Your AWS access key ID. Only required if your AWS account is a GovCloud or China account. | [optional] | +| **account_id** | **String** | Your AWS Account ID without dashes. | [optional] | +| **account_specific_namespace_rules** | **Hash<String, Boolean>** | An object, (in the form `{\"namespace1\":true/false, \"namespace2\":true/false}`), that enables or disables metric collection for specific AWS namespaces for this AWS account only. | [optional] | +| **cspm_resource_collection_enabled** | **Boolean** | Whether Datadog collects cloud security posture management resources from your AWS account. This includes additional resources not covered under the general `resource_collection`. | [optional][default to false] | +| **excluded_regions** | **Array<String>** | An array of AWS regions to exclude from metrics collection. | [optional] | +| **filter_tags** | **Array<String>** | The array of EC2 tags (in the form `key:value`) defines a filter that Datadog uses when collecting metrics from EC2. Wildcards, such as `?` (for single characters) and `_` (for multiple characters) can also be used. Only hosts that match one of the defined tags will be imported into Datadog. The rest will be ignored. Host matching a given tag can also be excluded by adding `!` before the tag. For example, `env:production,instance-type:c1._,!region:us-east-1` | [optional] | +| **host_tags** | **Array<String>** | Array of tags (in the form `key:value`) to add to all hosts and metrics reporting through this integration. | [optional] | +| **metrics_collection_enabled** | **Boolean** | Whether Datadog collects metrics for this AWS account. | [optional][default to true] | +| **resource_collection_enabled** | **Boolean** | Whether Datadog collects a standard set of resources from your AWS account. | [optional][default to false] | +| **role_name** | **String** | Your Datadog role delegation name. | [optional] | +| **secret_access_key** | **String** | Your AWS secret access key. Only required if your AWS account is a GovCloud or China account. | [optional] | ## Example @@ -35,4 +35,3 @@ instance = DatadogAPIClient::V1::AWSAccount.new( secret_access_key: null ) ``` - diff --git a/docs/v1/AWSAccountAndLambdaRequest.md b/docs/v1/AWSAccountAndLambdaRequest.md index 36008aecb632..8f76d38de672 100644 --- a/docs/v1/AWSAccountAndLambdaRequest.md +++ b/docs/v1/AWSAccountAndLambdaRequest.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **account_id** | **String** | Your AWS Account ID without dashes. | | -| **lambda_arn** | **String** | ARN of the Datadog Lambda created during the Datadog-Amazon Web services Log collection setup. | | +| Name | Type | Description | Notes | +| -------------- | ---------- | ---------------------------------------------------------------------------------------------- | ----- | +| **account_id** | **String** | Your AWS Account ID without dashes. | | +| **lambda_arn** | **String** | ARN of the Datadog Lambda created during the Datadog-Amazon Web services Log collection setup. | | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::AWSAccountAndLambdaRequest.new( lambda_arn: arn:aws:lambda:us-east-1:1234567:function:LogsCollectionAPITest ) ``` - diff --git a/docs/v1/AWSAccountCreateResponse.md b/docs/v1/AWSAccountCreateResponse.md index ffbe05ab983e..aa2c67be771a 100644 --- a/docs/v1/AWSAccountCreateResponse.md +++ b/docs/v1/AWSAccountCreateResponse.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| --------------- | ---------- | ---------------- | ---------- | | **external_id** | **String** | AWS external_id. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::AWSAccountCreateResponse.new( external_id: null ) ``` - diff --git a/docs/v1/AWSAccountDeleteRequest.md b/docs/v1/AWSAccountDeleteRequest.md index fb5e6ce1ef01..b069c152e054 100644 --- a/docs/v1/AWSAccountDeleteRequest.md +++ b/docs/v1/AWSAccountDeleteRequest.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| ----------------- | ---------- | ----------------------------------------------------------------------------------------- | ---------- | | **access_key_id** | **String** | Your AWS access key ID. Only required if your AWS account is a GovCloud or China account. | [optional] | -| **account_id** | **String** | Your AWS Account ID without dashes. | [optional] | -| **role_name** | **String** | Your Datadog role delegation name. | [optional] | +| **account_id** | **String** | Your AWS Account ID without dashes. | [optional] | +| **role_name** | **String** | Your Datadog role delegation name. | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::AWSAccountDeleteRequest.new( role_name: DatadogAWSIntegrationRole ) ``` - diff --git a/docs/v1/AWSAccountListResponse.md b/docs/v1/AWSAccountListResponse.md index fd1666818589..62e82405cf17 100644 --- a/docs/v1/AWSAccountListResponse.md +++ b/docs/v1/AWSAccountListResponse.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| ------------ | -------------------------------------------- | ----------------------------- | ---------- | | **accounts** | [**Array<AWSAccount>**](AWSAccount.md) | List of enabled AWS accounts. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::AWSAccountListResponse.new( accounts: null ) ``` - diff --git a/docs/v1/AWSIntegrationAPI.md b/docs/v1/AWSIntegrationAPI.md index e670fae56f30..cd030ab6c453 100644 --- a/docs/v1/AWSIntegrationAPI.md +++ b/docs/v1/AWSIntegrationAPI.md @@ -2,18 +2,17 @@ All URIs are relative to *https://api.datadoghq.com* -| Method | HTTP request | Description | -| ------ | ------------ | ----------- | -| [**create_aws_account**](AWSIntegrationAPI.md#create_aws_account) | **POST** /api/v1/integration/aws | Create an AWS integration | -| [**create_aws_tag_filter**](AWSIntegrationAPI.md#create_aws_tag_filter) | **POST** /api/v1/integration/aws/filtering | Set an AWS tag filter | -| [**create_new_aws_external_id**](AWSIntegrationAPI.md#create_new_aws_external_id) | **PUT** /api/v1/integration/aws/generate_new_external_id | Generate a new external ID | -| [**delete_aws_account**](AWSIntegrationAPI.md#delete_aws_account) | **DELETE** /api/v1/integration/aws | Delete an AWS integration | -| [**delete_aws_tag_filter**](AWSIntegrationAPI.md#delete_aws_tag_filter) | **DELETE** /api/v1/integration/aws/filtering | Delete a tag filtering entry | -| [**list_available_aws_namespaces**](AWSIntegrationAPI.md#list_available_aws_namespaces) | **GET** /api/v1/integration/aws/available_namespace_rules | List namespace rules | -| [**list_aws_accounts**](AWSIntegrationAPI.md#list_aws_accounts) | **GET** /api/v1/integration/aws | List all AWS integrations | -| [**list_aws_tag_filters**](AWSIntegrationAPI.md#list_aws_tag_filters) | **GET** /api/v1/integration/aws/filtering | Get all AWS tag filters | -| [**update_aws_account**](AWSIntegrationAPI.md#update_aws_account) | **PUT** /api/v1/integration/aws | Update an AWS integration | - +| Method | HTTP request | Description | +| --------------------------------------------------------------------------------------- | --------------------------------------------------------- | ---------------------------- | +| [**create_aws_account**](AWSIntegrationAPI.md#create_aws_account) | **POST** /api/v1/integration/aws | Create an AWS integration | +| [**create_aws_tag_filter**](AWSIntegrationAPI.md#create_aws_tag_filter) | **POST** /api/v1/integration/aws/filtering | Set an AWS tag filter | +| [**create_new_aws_external_id**](AWSIntegrationAPI.md#create_new_aws_external_id) | **PUT** /api/v1/integration/aws/generate_new_external_id | Generate a new external ID | +| [**delete_aws_account**](AWSIntegrationAPI.md#delete_aws_account) | **DELETE** /api/v1/integration/aws | Delete an AWS integration | +| [**delete_aws_tag_filter**](AWSIntegrationAPI.md#delete_aws_tag_filter) | **DELETE** /api/v1/integration/aws/filtering | Delete a tag filtering entry | +| [**list_available_aws_namespaces**](AWSIntegrationAPI.md#list_available_aws_namespaces) | **GET** /api/v1/integration/aws/available_namespace_rules | List namespace rules | +| [**list_aws_accounts**](AWSIntegrationAPI.md#list_aws_accounts) | **GET** /api/v1/integration/aws | List all AWS integrations | +| [**list_aws_tag_filters**](AWSIntegrationAPI.md#list_aws_tag_filters) | **GET** /api/v1/integration/aws/filtering | Get all AWS tag filters | +| [**update_aws_account**](AWSIntegrationAPI.md#update_aws_account) | **PUT** /api/v1/integration/aws | Update an AWS integration | ## create_aws_account @@ -60,9 +59,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**AWSAccount**](AWSAccount.md) | AWS Request Object | | +| Name | Type | Description | Notes | +| -------- | ------------------------------- | ------------------ | ----- | +| **body** | [**AWSAccount**](AWSAccount.md) | AWS Request Object | | ### Return type @@ -77,7 +76,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## create_aws_tag_filter > Object create_aws_tag_filter(body) @@ -120,9 +118,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**AWSTagFilterCreateRequest**](AWSTagFilterCreateRequest.md) | Set an AWS tag filter using an `aws_account_identifier`, `namespace`, and filtering string. Namespace options are `application_elb`, `elb`, `lambda`, `network_elb`, `rds`, `sqs`, and `custom`. | | +| Name | Type | Description | Notes | +| -------- | ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----- | +| **body** | [**AWSTagFilterCreateRequest**](AWSTagFilterCreateRequest.md) | Set an AWS tag filter using an `aws_account_identifier`, `namespace`, and filtering string. Namespace options are `application_elb`, `elb`, `lambda`, `network_elb`, `rds`, `sqs`, and `custom`. | | ### Return type @@ -137,7 +135,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## create_new_aws_external_id > create_new_aws_external_id(body) @@ -180,9 +177,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**AWSAccount**](AWSAccount.md) | Your Datadog role delegation name. For more information about your AWS account Role name, see the [Datadog AWS integration configuration info](https://docs.datadoghq.com/integrations/amazon_web_services/#setup). | | +| Name | Type | Description | Notes | +| -------- | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- | +| **body** | [**AWSAccount**](AWSAccount.md) | Your Datadog role delegation name. For more information about your AWS account Role name, see the [Datadog AWS integration configuration info](https://docs.datadoghq.com/integrations/amazon_web_services/#setup). | | ### Return type @@ -197,7 +194,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## delete_aws_account > Object delete_aws_account(body) @@ -240,9 +236,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**AWSAccountDeleteRequest**](AWSAccountDeleteRequest.md) | AWS request object | | +| Name | Type | Description | Notes | +| -------- | --------------------------------------------------------- | ------------------ | ----- | +| **body** | [**AWSAccountDeleteRequest**](AWSAccountDeleteRequest.md) | AWS request object | | ### Return type @@ -257,7 +253,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## delete_aws_tag_filter > Object delete_aws_tag_filter(body) @@ -300,9 +295,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**AWSTagFilterDeleteRequest**](AWSTagFilterDeleteRequest.md) | Delete a tag filtering entry for a given AWS account and `dd-aws` namespace. | | +| Name | Type | Description | Notes | +| -------- | ------------------------------------------------------------- | -------------------------------------------------------------------------------------- | ----- | +| **body** | [**AWSTagFilterDeleteRequest**](AWSTagFilterDeleteRequest.md) | Delete a tag filtering entry for a given AWS account and `dd-aws` namespace. | | ### Return type @@ -317,7 +312,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## list_available_aws_namespaces > Array<String> list_available_aws_namespaces @@ -374,7 +368,6 @@ This endpoint does not need any parameter. - **Content-Type**: Not defined - **Accept**: application/json - ## list_aws_accounts > list_aws_accounts(opts) @@ -421,10 +414,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **account_id** | **String** | Only return AWS accounts that matches this `account_id`. | [optional] | -| **role_name** | **String** | Only return AWS accounts that matches this role_name. | [optional] | +| Name | Type | Description | Notes | +| ----------------- | ---------- | --------------------------------------------------------------------- | ---------- | +| **account_id** | **String** | Only return AWS accounts that matches this `account_id`. | [optional] | +| **role_name** | **String** | Only return AWS accounts that matches this role_name. | [optional] | | **access_key_id** | **String** | Only return AWS accounts that matches this `access_key_id`. | [optional] | ### Return type @@ -440,7 +433,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## list_aws_tag_filters > list_aws_tag_filters(account_id) @@ -483,9 +475,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **account_id** | **String** | Only return AWS filters that matches this `account_id`. | | +| Name | Type | Description | Notes | +| -------------- | ---------- | ----------------------------------------------------------------- | ----- | +| **account_id** | **String** | Only return AWS filters that matches this `account_id`. | | ### Return type @@ -500,7 +492,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## update_aws_account > Object update_aws_account(body, opts) @@ -548,12 +539,12 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**AWSAccount**](AWSAccount.md) | AWS request object | | -| **account_id** | **String** | Only return AWS accounts that matches this `account_id`. | [optional] | -| **role_name** | **String** | Only return AWS accounts that match this `role_name`. Required if `account_id` is specified. | [optional] | -| **access_key_id** | **String** | Only return AWS accounts that matches this `access_key_id`. Required if none of the other two options are specified. | [optional] | +| Name | Type | Description | Notes | +| ----------------- | ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | ---------- | +| **body** | [**AWSAccount**](AWSAccount.md) | AWS request object | | +| **account_id** | **String** | Only return AWS accounts that matches this `account_id`. | [optional] | +| **role_name** | **String** | Only return AWS accounts that match this `role_name`. Required if `account_id` is specified. | [optional] | +| **access_key_id** | **String** | Only return AWS accounts that matches this `access_key_id`. Required if none of the other two options are specified. | [optional] | ### Return type @@ -567,4 +558,3 @@ end - **Content-Type**: application/json - **Accept**: application/json - diff --git a/docs/v1/AWSLogsAsyncError.md b/docs/v1/AWSLogsAsyncError.md index b8c093b6e316..261016303a1c 100644 --- a/docs/v1/AWSLogsAsyncError.md +++ b/docs/v1/AWSLogsAsyncError.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **code** | **String** | Code properties | [optional] | +| Name | Type | Description | Notes | +| ----------- | ---------- | ---------------- | ---------- | +| **code** | **String** | Code properties | [optional] | | **message** | **String** | Message content. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::AWSLogsAsyncError.new( message: AWS account 12345 has no lambda config to update ) ``` - diff --git a/docs/v1/AWSLogsAsyncResponse.md b/docs/v1/AWSLogsAsyncResponse.md index bc2685ba8e9b..ecaa1442cdce 100644 --- a/docs/v1/AWSLogsAsyncResponse.md +++ b/docs/v1/AWSLogsAsyncResponse.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **errors** | [**Array<AWSLogsAsyncError>**](AWSLogsAsyncError.md) | List of errors. | [optional] | -| **status** | **String** | Status of the properties. | [optional] | +| Name | Type | Description | Notes | +| ---------- | ---------------------------------------------------------- | ------------------------- | ---------- | +| **errors** | [**Array<AWSLogsAsyncError>**](AWSLogsAsyncError.md) | List of errors. | [optional] | +| **status** | **String** | Status of the properties. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::AWSLogsAsyncResponse.new( status: created ) ``` - diff --git a/docs/v1/AWSLogsIntegrationAPI.md b/docs/v1/AWSLogsIntegrationAPI.md index c643df4ff9d3..28a84b3c6bc5 100644 --- a/docs/v1/AWSLogsIntegrationAPI.md +++ b/docs/v1/AWSLogsIntegrationAPI.md @@ -2,16 +2,15 @@ All URIs are relative to *https://api.datadoghq.com* -| Method | HTTP request | Description | -| ------ | ------------ | ----------- | -| [**check_aws_logs_lambda_async**](AWSLogsIntegrationAPI.md#check_aws_logs_lambda_async) | **POST** /api/v1/integration/aws/logs/check_async | Check that an AWS Lambda Function exists | -| [**check_aws_logs_services_async**](AWSLogsIntegrationAPI.md#check_aws_logs_services_async) | **POST** /api/v1/integration/aws/logs/services_async | Check permissions for log services | -| [**create_aws_lambda_arn**](AWSLogsIntegrationAPI.md#create_aws_lambda_arn) | **POST** /api/v1/integration/aws/logs | Add AWS Log Lambda ARN | -| [**delete_aws_lambda_arn**](AWSLogsIntegrationAPI.md#delete_aws_lambda_arn) | **DELETE** /api/v1/integration/aws/logs | Delete an AWS Logs integration | -| [**enable_aws_log_services**](AWSLogsIntegrationAPI.md#enable_aws_log_services) | **POST** /api/v1/integration/aws/logs/services | Enable an AWS Logs integration | -| [**list_aws_logs_integrations**](AWSLogsIntegrationAPI.md#list_aws_logs_integrations) | **GET** /api/v1/integration/aws/logs | List all AWS Logs integrations | -| [**list_aws_logs_services**](AWSLogsIntegrationAPI.md#list_aws_logs_services) | **GET** /api/v1/integration/aws/logs/services | Get list of AWS log ready services | - +| Method | HTTP request | Description | +| ------------------------------------------------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------- | +| [**check_aws_logs_lambda_async**](AWSLogsIntegrationAPI.md#check_aws_logs_lambda_async) | **POST** /api/v1/integration/aws/logs/check_async | Check that an AWS Lambda Function exists | +| [**check_aws_logs_services_async**](AWSLogsIntegrationAPI.md#check_aws_logs_services_async) | **POST** /api/v1/integration/aws/logs/services_async | Check permissions for log services | +| [**create_aws_lambda_arn**](AWSLogsIntegrationAPI.md#create_aws_lambda_arn) | **POST** /api/v1/integration/aws/logs | Add AWS Log Lambda ARN | +| [**delete_aws_lambda_arn**](AWSLogsIntegrationAPI.md#delete_aws_lambda_arn) | **DELETE** /api/v1/integration/aws/logs | Delete an AWS Logs integration | +| [**enable_aws_log_services**](AWSLogsIntegrationAPI.md#enable_aws_log_services) | **POST** /api/v1/integration/aws/logs/services | Enable an AWS Logs integration | +| [**list_aws_logs_integrations**](AWSLogsIntegrationAPI.md#list_aws_logs_integrations) | **GET** /api/v1/integration/aws/logs | List all AWS Logs integrations | +| [**list_aws_logs_services**](AWSLogsIntegrationAPI.md#list_aws_logs_services) | **GET** /api/v1/integration/aws/logs/services | Get list of AWS log ready services | ## check_aws_logs_lambda_async @@ -62,9 +61,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**AWSAccountAndLambdaRequest**](AWSAccountAndLambdaRequest.md) | Check AWS Log Lambda Async request body. | | +| Name | Type | Description | Notes | +| -------- | --------------------------------------------------------------- | ---------------------------------------- | ----- | +| **body** | [**AWSAccountAndLambdaRequest**](AWSAccountAndLambdaRequest.md) | Check AWS Log Lambda Async request body. | | ### Return type @@ -79,7 +78,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## check_aws_logs_services_async > check_aws_logs_services_async(body) @@ -131,9 +129,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**AWSLogsServicesRequest**](AWSLogsServicesRequest.md) | Check AWS Logs Async Services request body. | | +| Name | Type | Description | Notes | +| -------- | ------------------------------------------------------- | ------------------------------------------- | ----- | +| **body** | [**AWSLogsServicesRequest**](AWSLogsServicesRequest.md) | Check AWS Logs Async Services request body. | | ### Return type @@ -148,7 +146,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## create_aws_lambda_arn > Object create_aws_lambda_arn(body) @@ -191,9 +188,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**AWSAccountAndLambdaRequest**](AWSAccountAndLambdaRequest.md) | AWS Log Lambda Async request body. | | +| Name | Type | Description | Notes | +| -------- | --------------------------------------------------------------- | ---------------------------------- | ----- | +| **body** | [**AWSAccountAndLambdaRequest**](AWSAccountAndLambdaRequest.md) | AWS Log Lambda Async request body. | | ### Return type @@ -208,7 +205,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## delete_aws_lambda_arn > Object delete_aws_lambda_arn(body) @@ -251,9 +247,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**AWSAccountAndLambdaRequest**](AWSAccountAndLambdaRequest.md) | Delete AWS Lambda ARN request body. | | +| Name | Type | Description | Notes | +| -------- | --------------------------------------------------------------- | ----------------------------------- | ----- | +| **body** | [**AWSAccountAndLambdaRequest**](AWSAccountAndLambdaRequest.md) | Delete AWS Lambda ARN request body. | | ### Return type @@ -268,7 +264,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## enable_aws_log_services > Object enable_aws_log_services(body) @@ -311,9 +306,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**AWSLogsServicesRequest**](AWSLogsServicesRequest.md) | Enable AWS Log Services request body. | | +| Name | Type | Description | Notes | +| -------- | ------------------------------------------------------- | ------------------------------------- | ----- | +| **body** | [**AWSLogsServicesRequest**](AWSLogsServicesRequest.md) | Enable AWS Log Services request body. | | ### Return type @@ -328,7 +323,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## list_aws_logs_integrations > > list_aws_logs_integrations @@ -385,7 +379,6 @@ This endpoint does not need any parameter. - **Content-Type**: Not defined - **Accept**: application/json - ## list_aws_logs_services > > list_aws_logs_services @@ -441,4 +434,3 @@ This endpoint does not need any parameter. - **Content-Type**: Not defined - **Accept**: application/json - diff --git a/docs/v1/AWSLogsLambda.md b/docs/v1/AWSLogsLambda.md index abf288f6a445..a560507080b1 100644 --- a/docs/v1/AWSLogsLambda.md +++ b/docs/v1/AWSLogsLambda.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| ------- | ---------- | ------------------ | ---------- | | **arn** | **String** | Available ARN IDs. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::AWSLogsLambda.new( arn: null ) ``` - diff --git a/docs/v1/AWSLogsListResponse.md b/docs/v1/AWSLogsListResponse.md index 676f848de80c..8aa2b02c804d 100644 --- a/docs/v1/AWSLogsListResponse.md +++ b/docs/v1/AWSLogsListResponse.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **account_id** | **String** | Your AWS Account ID without dashes. | [optional] | -| **lambdas** | [**Array<AWSLogsLambda>**](AWSLogsLambda.md) | List of ARNs configured in your Datadog account. | [optional] | -| **services** | **Array<String>** | Array of services IDs. | [optional] | +| Name | Type | Description | Notes | +| -------------- | -------------------------------------------------- | ------------------------------------------------ | ---------- | +| **account_id** | **String** | Your AWS Account ID without dashes. | [optional] | +| **lambdas** | [**Array<AWSLogsLambda>**](AWSLogsLambda.md) | List of ARNs configured in your Datadog account. | [optional] | +| **services** | **Array<String>** | Array of services IDs. | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::AWSLogsListResponse.new( services: ["s3","elb","elbv2","cloudfront","redshift","lambda"] ) ``` - diff --git a/docs/v1/AWSLogsListServicesResponse.md b/docs/v1/AWSLogsListServicesResponse.md index 7ecdd8649e50..4c6a90031651 100644 --- a/docs/v1/AWSLogsListServicesResponse.md +++ b/docs/v1/AWSLogsListServicesResponse.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **id** | **String** | Key value in returned object. | [optional] | +| Name | Type | Description | Notes | +| --------- | ---------- | -------------------------------------------------------------- | ---------- | +| **id** | **String** | Key value in returned object. | [optional] | | **label** | **String** | Name of service available for configuration with Datadog logs. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::AWSLogsListServicesResponse.new( label: S3 Access Logs ) ``` - diff --git a/docs/v1/AWSLogsServicesRequest.md b/docs/v1/AWSLogsServicesRequest.md index c91a9e4d5937..7c3d1d5b7a69 100644 --- a/docs/v1/AWSLogsServicesRequest.md +++ b/docs/v1/AWSLogsServicesRequest.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **account_id** | **String** | Your AWS Account ID without dashes. | | -| **services** | **Array<String>** | Array of services IDs set to enable automatic log collection. Discover the list of available services with the get list of AWS log ready services API endpoint. | | +| Name | Type | Description | Notes | +| -------------- | ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- | +| **account_id** | **String** | Your AWS Account ID without dashes. | | +| **services** | **Array<String>** | Array of services IDs set to enable automatic log collection. Discover the list of available services with the get list of AWS log ready services API endpoint. | | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::AWSLogsServicesRequest.new( services: ["s3","elb","elbv2","cloudfront","redshift","lambda"] ) ``` - diff --git a/docs/v1/AWSNamespace.md b/docs/v1/AWSNamespace.md index 42c53e7afc0b..f6863b05b416 100644 --- a/docs/v1/AWSNamespace.md +++ b/docs/v1/AWSNamespace.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::AWSNamespace.new() ``` - diff --git a/docs/v1/AWSTagFilter.md b/docs/v1/AWSTagFilter.md index 42892b87c574..dc320604977a 100644 --- a/docs/v1/AWSTagFilter.md +++ b/docs/v1/AWSTagFilter.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **namespace** | [**AWSNamespace**](AWSNamespace.md) | | [optional] | -| **tag_filter_str** | **String** | The tag filter string. | [optional] | +| Name | Type | Description | Notes | +| ------------------ | ----------------------------------- | ---------------------- | ---------- | +| **namespace** | [**AWSNamespace**](AWSNamespace.md) | | [optional] | +| **tag_filter_str** | **String** | The tag filter string. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::AWSTagFilter.new( tag_filter_str: prod* ) ``` - diff --git a/docs/v1/AWSTagFilterCreateRequest.md b/docs/v1/AWSTagFilterCreateRequest.md index 26af61bed192..8466ec6ee25e 100644 --- a/docs/v1/AWSTagFilterCreateRequest.md +++ b/docs/v1/AWSTagFilterCreateRequest.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **account_id** | **String** | Your AWS Account ID without dashes. | [optional] | -| **namespace** | [**AWSNamespace**](AWSNamespace.md) | | [optional] | -| **tag_filter_str** | **String** | The tag filter string. | [optional] | +| Name | Type | Description | Notes | +| ------------------ | ----------------------------------- | ----------------------------------- | ---------- | +| **account_id** | **String** | Your AWS Account ID without dashes. | [optional] | +| **namespace** | [**AWSNamespace**](AWSNamespace.md) | | [optional] | +| **tag_filter_str** | **String** | The tag filter string. | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::AWSTagFilterCreateRequest.new( tag_filter_str: prod* ) ``` - diff --git a/docs/v1/AWSTagFilterDeleteRequest.md b/docs/v1/AWSTagFilterDeleteRequest.md index aad8d7ecaee5..a6266aa71477 100644 --- a/docs/v1/AWSTagFilterDeleteRequest.md +++ b/docs/v1/AWSTagFilterDeleteRequest.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **account_id** | **String** | The unique identifier of your AWS account. | [optional] | -| **namespace** | [**AWSNamespace**](AWSNamespace.md) | | [optional] | +| Name | Type | Description | Notes | +| -------------- | ----------------------------------- | ------------------------------------------ | ---------- | +| **account_id** | **String** | The unique identifier of your AWS account. | [optional] | +| **namespace** | [**AWSNamespace**](AWSNamespace.md) | | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::AWSTagFilterDeleteRequest.new( namespace: null ) ``` - diff --git a/docs/v1/AWSTagFilterListResponse.md b/docs/v1/AWSTagFilterListResponse.md index 17a2b0c84e95..8698d70cb0e4 100644 --- a/docs/v1/AWSTagFilterListResponse.md +++ b/docs/v1/AWSTagFilterListResponse.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| ----------- | ------------------------------------------------ | ------------------------ | ---------- | | **filters** | [**Array<AWSTagFilter>**](AWSTagFilter.md) | An array of tag filters. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::AWSTagFilterListResponse.new( filters: null ) ``` - diff --git a/docs/v1/AccessRole.md b/docs/v1/AccessRole.md index 54504d55f72a..211678dcbc4f 100644 --- a/docs/v1/AccessRole.md +++ b/docs/v1/AccessRole.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::AccessRole.new() ``` - diff --git a/docs/v1/AlertGraphWidgetDefinition.md b/docs/v1/AlertGraphWidgetDefinition.md index 2b6fa43029a5..f6a83d6ab50b 100644 --- a/docs/v1/AlertGraphWidgetDefinition.md +++ b/docs/v1/AlertGraphWidgetDefinition.md @@ -2,15 +2,15 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **alert_id** | **String** | ID of the alert to use in the widget. | | -| **time** | [**WidgetTime**](WidgetTime.md) | | [optional] | -| **title** | **String** | The title of the widget. | [optional] | -| **title_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | -| **title_size** | **String** | Size of the title. | [optional] | -| **type** | [**AlertGraphWidgetDefinitionType**](AlertGraphWidgetDefinitionType.md) | | [default to 'alert_graph'] | -| **viz_type** | [**WidgetVizType**](WidgetVizType.md) | | | +| Name | Type | Description | Notes | +| --------------- | ----------------------------------------------------------------------- | ------------------------------------- | ---------------------------------- | +| **alert_id** | **String** | ID of the alert to use in the widget. | | +| **time** | [**WidgetTime**](WidgetTime.md) | | [optional] | +| **title** | **String** | The title of the widget. | [optional] | +| **title_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | +| **title_size** | **String** | Size of the title. | [optional] | +| **type** | [**AlertGraphWidgetDefinitionType**](AlertGraphWidgetDefinitionType.md) | | [default to 'alert_graph'] | +| **viz_type** | [**WidgetVizType**](WidgetVizType.md) | | | ## Example @@ -27,4 +27,3 @@ instance = DatadogAPIClient::V1::AlertGraphWidgetDefinition.new( viz_type: null ) ``` - diff --git a/docs/v1/AlertGraphWidgetDefinitionType.md b/docs/v1/AlertGraphWidgetDefinitionType.md index 3e6730246a82..746b0e369b62 100644 --- a/docs/v1/AlertGraphWidgetDefinitionType.md +++ b/docs/v1/AlertGraphWidgetDefinitionType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::AlertGraphWidgetDefinitionType.new() ``` - diff --git a/docs/v1/AlertValueWidgetDefinition.md b/docs/v1/AlertValueWidgetDefinition.md index f4349bdbc90b..30dbe4c02ead 100644 --- a/docs/v1/AlertValueWidgetDefinition.md +++ b/docs/v1/AlertValueWidgetDefinition.md @@ -2,16 +2,16 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **alert_id** | **String** | ID of the alert to use in the widget. | | -| **precision** | **Integer** | Number of decimal to show. If not defined, will use the raw value. | [optional] | -| **text_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | -| **title** | **String** | Title of the widget. | [optional] | -| **title_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | -| **title_size** | **String** | Size of value in the widget. | [optional] | -| **type** | [**AlertValueWidgetDefinitionType**](AlertValueWidgetDefinitionType.md) | | [default to 'alert_value'] | -| **unit** | **String** | Unit to display with the value. | [optional] | +| Name | Type | Description | Notes | +| --------------- | ----------------------------------------------------------------------- | ------------------------------------------------------------------ | ---------------------------------- | +| **alert_id** | **String** | ID of the alert to use in the widget. | | +| **precision** | **Integer** | Number of decimal to show. If not defined, will use the raw value. | [optional] | +| **text_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | +| **title** | **String** | Title of the widget. | [optional] | +| **title_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | +| **title_size** | **String** | Size of value in the widget. | [optional] | +| **type** | [**AlertValueWidgetDefinitionType**](AlertValueWidgetDefinitionType.md) | | [default to 'alert_value'] | +| **unit** | **String** | Unit to display with the value. | [optional] | ## Example @@ -29,4 +29,3 @@ instance = DatadogAPIClient::V1::AlertValueWidgetDefinition.new( unit: null ) ``` - diff --git a/docs/v1/AlertValueWidgetDefinitionType.md b/docs/v1/AlertValueWidgetDefinitionType.md index ade2e2ff76f4..45324deea16e 100644 --- a/docs/v1/AlertValueWidgetDefinitionType.md +++ b/docs/v1/AlertValueWidgetDefinitionType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::AlertValueWidgetDefinitionType.new() ``` - diff --git a/docs/v1/ApiKey.md b/docs/v1/ApiKey.md index f48ce06374fe..f8bfdaf21a59 100644 --- a/docs/v1/ApiKey.md +++ b/docs/v1/ApiKey.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **created** | **String** | Date of creation of the API key. | [optional][readonly] | +| Name | Type | Description | Notes | +| -------------- | ---------- | --------------------------------------------- | -------------------- | +| **created** | **String** | Date of creation of the API key. | [optional][readonly] | | **created_by** | **String** | Datadog user handle that created the API key. | [optional][readonly] | -| **key** | **String** | API key. | [optional][readonly] | -| **name** | **String** | Name of your API key. | [optional] | +| **key** | **String** | API key. | [optional][readonly] | +| **name** | **String** | Name of your API key. | [optional] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V1::ApiKey.new( name: example user ) ``` - diff --git a/docs/v1/ApiKeyListResponse.md b/docs/v1/ApiKeyListResponse.md index c484c6c1113b..b2905aacd290 100644 --- a/docs/v1/ApiKeyListResponse.md +++ b/docs/v1/ApiKeyListResponse.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| ------------ | ------------------------------------ | ------------------ | ---------- | | **api_keys** | [**Array<ApiKey>**](ApiKey.md) | Array of API keys. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::ApiKeyListResponse.new( api_keys: null ) ``` - diff --git a/docs/v1/ApiKeyResponse.md b/docs/v1/ApiKeyResponse.md index 636fd7efd8ca..53fe06c2013b 100644 --- a/docs/v1/ApiKeyResponse.md +++ b/docs/v1/ApiKeyResponse.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **api_key** | [**ApiKey**](ApiKey.md) | | [optional] | +| Name | Type | Description | Notes | +| ----------- | ----------------------- | ----------- | ---------- | +| **api_key** | [**ApiKey**](ApiKey.md) | | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::ApiKeyResponse.new( api_key: null ) ``` - diff --git a/docs/v1/ApmStatsQueryColumnType.md b/docs/v1/ApmStatsQueryColumnType.md index abc7e337b6b3..3fc1bc0d795d 100644 --- a/docs/v1/ApmStatsQueryColumnType.md +++ b/docs/v1/ApmStatsQueryColumnType.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **_alias** | **String** | A user-assigned alias for the column. | [optional] | -| **cell_display_mode** | [**TableWidgetCellDisplayMode**](TableWidgetCellDisplayMode.md) | | [optional] | -| **name** | **String** | Column name. | | -| **order** | [**WidgetSort**](WidgetSort.md) | | [optional] | +| Name | Type | Description | Notes | +| --------------------- | --------------------------------------------------------------- | ------------------------------------- | ---------- | +| **\_alias** | **String** | A user-assigned alias for the column. | [optional] | +| **cell_display_mode** | [**TableWidgetCellDisplayMode**](TableWidgetCellDisplayMode.md) | | [optional] | +| **name** | **String** | Column name. | | +| **order** | [**WidgetSort**](WidgetSort.md) | | [optional] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V1::ApmStatsQueryColumnType.new( order: null ) ``` - diff --git a/docs/v1/ApmStatsQueryDefinition.md b/docs/v1/ApmStatsQueryDefinition.md index 328901a7f02a..0fcf56131ca2 100644 --- a/docs/v1/ApmStatsQueryDefinition.md +++ b/docs/v1/ApmStatsQueryDefinition.md @@ -2,15 +2,15 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **columns** | [**Array<ApmStatsQueryColumnType>**](ApmStatsQueryColumnType.md) | Column properties used by the front end for display. | [optional] | -| **env** | **String** | Environment name. | | -| **name** | **String** | Operation name associated with service. | | -| **primary_tag** | **String** | The organization's host group name and value. | | -| **resource** | **String** | Resource name. | [optional] | -| **row_type** | [**ApmStatsQueryRowType**](ApmStatsQueryRowType.md) | | | -| **service** | **String** | Service name. | | +| Name | Type | Description | Notes | +| --------------- | ---------------------------------------------------------------------- | ---------------------------------------------------- | ---------- | +| **columns** | [**Array<ApmStatsQueryColumnType>**](ApmStatsQueryColumnType.md) | Column properties used by the front end for display. | [optional] | +| **env** | **String** | Environment name. | | +| **name** | **String** | Operation name associated with service. | | +| **primary_tag** | **String** | The organization's host group name and value. | | +| **resource** | **String** | Resource name. | [optional] | +| **row_type** | [**ApmStatsQueryRowType**](ApmStatsQueryRowType.md) | | | +| **service** | **String** | Service name. | | ## Example @@ -27,4 +27,3 @@ instance = DatadogAPIClient::V1::ApmStatsQueryDefinition.new( service: web-store ) ``` - diff --git a/docs/v1/ApmStatsQueryRowType.md b/docs/v1/ApmStatsQueryRowType.md index e72bc6114ee5..650ecc2b39fb 100644 --- a/docs/v1/ApmStatsQueryRowType.md +++ b/docs/v1/ApmStatsQueryRowType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::ApmStatsQueryRowType.new() ``` - diff --git a/docs/v1/ApplicationKey.md b/docs/v1/ApplicationKey.md index f66769ef661a..09e5f3614a54 100644 --- a/docs/v1/ApplicationKey.md +++ b/docs/v1/ApplicationKey.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **hash** | **String** | Hash of an application key. | [optional][readonly] | -| **name** | **String** | Name of an application key. | [optional] | +| Name | Type | Description | Notes | +| --------- | ---------- | ---------------------------- | -------------------- | +| **hash** | **String** | Hash of an application key. | [optional][readonly] | +| **name** | **String** | Name of an application key. | [optional] | | **owner** | **String** | Owner of an application key. | [optional][readonly] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::ApplicationKey.new( owner: example.com ) ``` - diff --git a/docs/v1/ApplicationKeyListResponse.md b/docs/v1/ApplicationKeyListResponse.md index d0cf902f1f8c..cfc799063c70 100644 --- a/docs/v1/ApplicationKeyListResponse.md +++ b/docs/v1/ApplicationKeyListResponse.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| -------------------- | ---------------------------------------------------- | -------------------------- | ---------- | | **application_keys** | [**Array<ApplicationKey>**](ApplicationKey.md) | Array of application keys. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::ApplicationKeyListResponse.new( application_keys: null ) ``` - diff --git a/docs/v1/ApplicationKeyResponse.md b/docs/v1/ApplicationKeyResponse.md index 0b7ec5a407fd..0fe3327af2c2 100644 --- a/docs/v1/ApplicationKeyResponse.md +++ b/docs/v1/ApplicationKeyResponse.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **application_key** | [**ApplicationKey**](ApplicationKey.md) | | [optional] | +| Name | Type | Description | Notes | +| ------------------- | --------------------------------------- | ----------- | ---------- | +| **application_key** | [**ApplicationKey**](ApplicationKey.md) | | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::ApplicationKeyResponse.new( application_key: null ) ``` - diff --git a/docs/v1/AuthenticationAPI.md b/docs/v1/AuthenticationAPI.md index e69c1f3f9e7d..ee55a4c45f94 100644 --- a/docs/v1/AuthenticationAPI.md +++ b/docs/v1/AuthenticationAPI.md @@ -2,11 +2,10 @@ All URIs are relative to *https://api.datadoghq.com* -| Method | HTTP request | Description | -| ------ | ------------ | ----------- | +| Method | HTTP request | Description | +| --------------------------------------------- | ------------------------ | ---------------- | | [**validate**](AuthenticationAPI.md#validate) | **GET** /api/v1/validate | Validate API key | - ## validate > validate @@ -62,4 +61,3 @@ This endpoint does not need any parameter. - **Content-Type**: Not defined - **Accept**: application/json - diff --git a/docs/v1/AuthenticationValidationResponse.md b/docs/v1/AuthenticationValidationResponse.md index 6ed0e5e8f9bd..c961433ae7a4 100644 --- a/docs/v1/AuthenticationValidationResponse.md +++ b/docs/v1/AuthenticationValidationResponse.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| --------- | ----------- | ---------------------------------------------------------------- | -------------------- | | **valid** | **Boolean** | Return `true` if the authentication response is valid. | [optional][readonly] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::AuthenticationValidationResponse.new( valid: true ) ``` - diff --git a/docs/v1/AzureAccount.md b/docs/v1/AzureAccount.md index 6cfe6d93559e..28904ab9fae5 100644 --- a/docs/v1/AzureAccount.md +++ b/docs/v1/AzureAccount.md @@ -2,15 +2,15 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **client_id** | **String** | Your Azure web application ID. | [optional] | -| **client_secret** | **String** | Your Azure web application secret key. | [optional] | -| **errors** | **Array<String>** | Errors in your configuration. | [optional] | -| **host_filters** | **String** | Limit the Azure instances that are pulled into Datadog by using tags. Only hosts that match one of the defined tags are imported into Datadog. | [optional] | -| **new_client_id** | **String** | Your New Azure web application ID. | [optional] | -| **new_tenant_name** | **String** | Your New Azure Active Directory ID. | [optional] | -| **tenant_name** | **String** | Your Azure Active Directory ID. | [optional] | +| Name | Type | Description | Notes | +| ------------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **client_id** | **String** | Your Azure web application ID. | [optional] | +| **client_secret** | **String** | Your Azure web application secret key. | [optional] | +| **errors** | **Array<String>** | Errors in your configuration. | [optional] | +| **host_filters** | **String** | Limit the Azure instances that are pulled into Datadog by using tags. Only hosts that match one of the defined tags are imported into Datadog. | [optional] | +| **new_client_id** | **String** | Your New Azure web application ID. | [optional] | +| **new_tenant_name** | **String** | Your New Azure Active Directory ID. | [optional] | +| **tenant_name** | **String** | Your Azure Active Directory ID. | [optional] | ## Example @@ -27,4 +27,3 @@ instance = DatadogAPIClient::V1::AzureAccount.new( tenant_name: testc44-1234-5678-9101-cc00736ftest ) ``` - diff --git a/docs/v1/AzureIntegrationAPI.md b/docs/v1/AzureIntegrationAPI.md index 66b85f12dac7..261f734630a9 100644 --- a/docs/v1/AzureIntegrationAPI.md +++ b/docs/v1/AzureIntegrationAPI.md @@ -2,14 +2,13 @@ All URIs are relative to *https://api.datadoghq.com* -| Method | HTTP request | Description | -| ------ | ------------ | ----------- | -| [**create_azure_integration**](AzureIntegrationAPI.md#create_azure_integration) | **POST** /api/v1/integration/azure | Create an Azure integration | -| [**delete_azure_integration**](AzureIntegrationAPI.md#delete_azure_integration) | **DELETE** /api/v1/integration/azure | Delete an Azure integration | -| [**list_azure_integration**](AzureIntegrationAPI.md#list_azure_integration) | **GET** /api/v1/integration/azure | List all Azure integrations | +| Method | HTTP request | Description | +| --------------------------------------------------------------------------------- | ----------------------------------------------- | ------------------------------------- | +| [**create_azure_integration**](AzureIntegrationAPI.md#create_azure_integration) | **POST** /api/v1/integration/azure | Create an Azure integration | +| [**delete_azure_integration**](AzureIntegrationAPI.md#delete_azure_integration) | **DELETE** /api/v1/integration/azure | Delete an Azure integration | +| [**list_azure_integration**](AzureIntegrationAPI.md#list_azure_integration) | **GET** /api/v1/integration/azure | List all Azure integrations | | [**update_azure_host_filters**](AzureIntegrationAPI.md#update_azure_host_filters) | **POST** /api/v1/integration/azure/host_filters | Update Azure integration host filters | -| [**update_azure_integration**](AzureIntegrationAPI.md#update_azure_integration) | **PUT** /api/v1/integration/azure | Update an Azure integration | - +| [**update_azure_integration**](AzureIntegrationAPI.md#update_azure_integration) | **PUT** /api/v1/integration/azure | Update an Azure integration | ## create_azure_integration @@ -59,9 +58,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**AzureAccount**](AzureAccount.md) | Create a Datadog-Azure integration for your Datadog account request body. | | +| Name | Type | Description | Notes | +| -------- | ----------------------------------- | ------------------------------------------------------------------------- | ----- | +| **body** | [**AzureAccount**](AzureAccount.md) | Create a Datadog-Azure integration for your Datadog account request body. | | ### Return type @@ -76,7 +75,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## delete_azure_integration > Object delete_azure_integration(body) @@ -119,9 +117,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**AzureAccount**](AzureAccount.md) | Delete a given Datadog-Azure integration request body. | | +| Name | Type | Description | Notes | +| -------- | ----------------------------------- | ------------------------------------------------------ | ----- | +| **body** | [**AzureAccount**](AzureAccount.md) | Delete a given Datadog-Azure integration request body. | | ### Return type @@ -136,7 +134,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## list_azure_integration > > list_azure_integration @@ -193,7 +190,6 @@ This endpoint does not need any parameter. - **Content-Type**: Not defined - **Accept**: application/json - ## update_azure_host_filters > Object update_azure_host_filters(body) @@ -236,9 +232,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**AzureAccount**](AzureAccount.md) | Update a Datadog-Azure integration's host filters request body. | | +| Name | Type | Description | Notes | +| -------- | ----------------------------------- | ------------------------------------------------------------------- | ----- | +| **body** | [**AzureAccount**](AzureAccount.md) | Update a Datadog-Azure integration's host filters request body. | | ### Return type @@ -253,7 +249,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## update_azure_integration > Object update_azure_integration(body) @@ -298,9 +293,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**AzureAccount**](AzureAccount.md) | Update a Datadog-Azure integration request body. | | +| Name | Type | Description | Notes | +| -------- | ----------------------------------- | ------------------------------------------------ | ----- | +| **body** | [**AzureAccount**](AzureAccount.md) | Update a Datadog-Azure integration request body. | | ### Return type @@ -314,4 +309,3 @@ end - **Content-Type**: application/json - **Accept**: application/json - diff --git a/docs/v1/CancelDowntimesByScopeRequest.md b/docs/v1/CancelDowntimesByScopeRequest.md index 64545f9b8db6..a1458a1f47ea 100644 --- a/docs/v1/CancelDowntimesByScopeRequest.md +++ b/docs/v1/CancelDowntimesByScopeRequest.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **scope** | **String** | The scope(s) to which the downtime applies. For example, `host:app2`. Provide multiple scopes as a comma-separated list like `env:dev,env:prod`. The resulting downtime applies to sources that matches ALL provided scopes (`env:dev` **AND** `env:prod`). | | +| Name | Type | Description | Notes | +| --------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- | +| **scope** | **String** | The scope(s) to which the downtime applies. For example, `host:app2`. Provide multiple scopes as a comma-separated list like `env:dev,env:prod`. The resulting downtime applies to sources that matches ALL provided scopes (`env:dev` **AND** `env:prod`). | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::CancelDowntimesByScopeRequest.new( scope: host:myserver ) ``` - diff --git a/docs/v1/CanceledDowntimesIds.md b/docs/v1/CanceledDowntimesIds.md index 62ba2d5d815f..3358d734c881 100644 --- a/docs/v1/CanceledDowntimesIds.md +++ b/docs/v1/CanceledDowntimesIds.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| ----------------- | ------------------------ | ----------------------------------- | ---------- | | **cancelled_ids** | **Array<Integer>** | ID of downtimes that were canceled. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::CanceledDowntimesIds.new( cancelled_ids: [123456789,123456790] ) ``` - diff --git a/docs/v1/ChangeWidgetDefinition.md b/docs/v1/ChangeWidgetDefinition.md index 35d8b242cef8..be0ec799aeb4 100644 --- a/docs/v1/ChangeWidgetDefinition.md +++ b/docs/v1/ChangeWidgetDefinition.md @@ -2,15 +2,15 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **custom_links** | [**Array<WidgetCustomLink>**](WidgetCustomLink.md) | List of custom links. | [optional] | -| **requests** | [**Array<ChangeWidgetRequest>**](ChangeWidgetRequest.md) | Array of one request object to display in the widget. See the dedicated [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json) to learn how to build the `REQUEST_SCHEMA`. | | -| **time** | [**WidgetTime**](WidgetTime.md) | | [optional] | -| **title** | **String** | Title of the widget. | [optional] | -| **title_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | -| **title_size** | **String** | Size of the title. | [optional] | -| **type** | [**ChangeWidgetDefinitionType**](ChangeWidgetDefinitionType.md) | | [default to 'change'] | +| Name | Type | Description | Notes | +| ---------------- | --------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | +| **custom_links** | [**Array<WidgetCustomLink>**](WidgetCustomLink.md) | List of custom links. | [optional] | +| **requests** | [**Array<ChangeWidgetRequest>**](ChangeWidgetRequest.md) | Array of one request object to display in the widget. See the dedicated [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json) to learn how to build the `REQUEST_SCHEMA`. | | +| **time** | [**WidgetTime**](WidgetTime.md) | | [optional] | +| **title** | **String** | Title of the widget. | [optional] | +| **title_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | +| **title_size** | **String** | Size of the title. | [optional] | +| **type** | [**ChangeWidgetDefinitionType**](ChangeWidgetDefinitionType.md) | | [default to 'change'] | ## Example @@ -27,4 +27,3 @@ instance = DatadogAPIClient::V1::ChangeWidgetDefinition.new( type: null ) ``` - diff --git a/docs/v1/ChangeWidgetDefinitionType.md b/docs/v1/ChangeWidgetDefinitionType.md index 6c2501025c7f..2a898a000573 100644 --- a/docs/v1/ChangeWidgetDefinitionType.md +++ b/docs/v1/ChangeWidgetDefinitionType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::ChangeWidgetDefinitionType.new() ``` - diff --git a/docs/v1/ChangeWidgetRequest.md b/docs/v1/ChangeWidgetRequest.md index a4d45fc3981e..b585401cb0e9 100644 --- a/docs/v1/ChangeWidgetRequest.md +++ b/docs/v1/ChangeWidgetRequest.md @@ -2,23 +2,23 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **apm_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **change_type** | [**WidgetChangeType**](WidgetChangeType.md) | | [optional] | -| **compare_to** | [**WidgetCompareTo**](WidgetCompareTo.md) | | [optional] | -| **event_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **increase_good** | **Boolean** | Whether to show increase as good. | [optional] | -| **log_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **network_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **order_by** | [**WidgetOrderBy**](WidgetOrderBy.md) | | [optional] | -| **order_dir** | [**WidgetSort**](WidgetSort.md) | | [optional] | -| **process_query** | [**ProcessQueryDefinition**](ProcessQueryDefinition.md) | | [optional] | -| **profile_metrics_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **q** | **String** | Query definition. | [optional] | -| **rum_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **security_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **show_present** | **Boolean** | Whether to show the present value. | [optional] | +| Name | Type | Description | Notes | +| ------------------------- | ------------------------------------------------------- | ---------------------------------- | ---------- | +| **apm_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **change_type** | [**WidgetChangeType**](WidgetChangeType.md) | | [optional] | +| **compare_to** | [**WidgetCompareTo**](WidgetCompareTo.md) | | [optional] | +| **event_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **increase_good** | **Boolean** | Whether to show increase as good. | [optional] | +| **log_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **network_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **order_by** | [**WidgetOrderBy**](WidgetOrderBy.md) | | [optional] | +| **order_dir** | [**WidgetSort**](WidgetSort.md) | | [optional] | +| **process_query** | [**ProcessQueryDefinition**](ProcessQueryDefinition.md) | | [optional] | +| **profile_metrics_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **q** | **String** | Query definition. | [optional] | +| **rum_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **security_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **show_present** | **Boolean** | Whether to show the present value. | [optional] | ## Example @@ -43,4 +43,3 @@ instance = DatadogAPIClient::V1::ChangeWidgetRequest.new( show_present: null ) ``` - diff --git a/docs/v1/CheckCanDeleteMonitorResponse.md b/docs/v1/CheckCanDeleteMonitorResponse.md index 84517fe8178b..2e97a8957912 100644 --- a/docs/v1/CheckCanDeleteMonitorResponse.md +++ b/docs/v1/CheckCanDeleteMonitorResponse.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**CheckCanDeleteMonitorResponseData**](CheckCanDeleteMonitorResponseData.md) | | | -| **errors** | **Hash<String, Array<String>>** | A mapping of Monitor ID to strings denoting where it's used. | [optional] | +| Name | Type | Description | Notes | +| ---------- | ----------------------------------------------------------------------------- | ---------------------------------------------------------------- | ---------- | +| **data** | [**CheckCanDeleteMonitorResponseData**](CheckCanDeleteMonitorResponseData.md) | | | +| **errors** | **Hash<String, Array<String>>** | A mapping of Monitor ID to strings denoting where it's used. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::CheckCanDeleteMonitorResponse.new( errors: null ) ``` - diff --git a/docs/v1/CheckCanDeleteMonitorResponseData.md b/docs/v1/CheckCanDeleteMonitorResponseData.md index 36ec63c9435c..1d822220ebe2 100644 --- a/docs/v1/CheckCanDeleteMonitorResponseData.md +++ b/docs/v1/CheckCanDeleteMonitorResponseData.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| ------ | ------------------------ | ------------------------------------------------------ | ---------- | | **ok** | **Array<Integer>** | An array of of Monitor IDs that can be safely deleted. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::CheckCanDeleteMonitorResponseData.new( ok: null ) ``` - diff --git a/docs/v1/CheckCanDeleteSLOResponse.md b/docs/v1/CheckCanDeleteSLOResponse.md index 730803c70e69..c3491b732992 100644 --- a/docs/v1/CheckCanDeleteSLOResponse.md +++ b/docs/v1/CheckCanDeleteSLOResponse.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**CheckCanDeleteSLOResponseData**](CheckCanDeleteSLOResponseData.md) | | [optional] | -| **errors** | **Hash<String, String>** | A mapping of SLO id to it's current usages. | [optional] | +| Name | Type | Description | Notes | +| ---------- | --------------------------------------------------------------------- | ----------------------------------------------- | ---------- | +| **data** | [**CheckCanDeleteSLOResponseData**](CheckCanDeleteSLOResponseData.md) | | [optional] | +| **errors** | **Hash<String, String>** | A mapping of SLO id to it's current usages. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::CheckCanDeleteSLOResponse.new( errors: null ) ``` - diff --git a/docs/v1/CheckCanDeleteSLOResponseData.md b/docs/v1/CheckCanDeleteSLOResponseData.md index 65d25579e5a6..73c41597e836 100644 --- a/docs/v1/CheckCanDeleteSLOResponseData.md +++ b/docs/v1/CheckCanDeleteSLOResponseData.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| ------ | ----------------------- | -------------------------------------------------- | ---------- | | **ok** | **Array<String>** | An array of of SLO IDs that can be safely deleted. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::CheckCanDeleteSLOResponseData.new( ok: null ) ``` - diff --git a/docs/v1/CheckStatusWidgetDefinition.md b/docs/v1/CheckStatusWidgetDefinition.md index c5cda216a203..d0c5037b033b 100644 --- a/docs/v1/CheckStatusWidgetDefinition.md +++ b/docs/v1/CheckStatusWidgetDefinition.md @@ -2,18 +2,18 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **check** | **String** | Name of the check to use in the widget. | | -| **group** | **String** | Group reporting a single check. | [optional] | -| **group_by** | **Array<String>** | List of tag prefixes to group by in the case of a cluster check. | [optional] | -| **grouping** | [**WidgetGrouping**](WidgetGrouping.md) | | | -| **tags** | **Array<String>** | List of tags used to filter the groups reporting a cluster check. | [optional] | -| **time** | [**WidgetTime**](WidgetTime.md) | | [optional] | -| **title** | **String** | Title of the widget. | [optional] | -| **title_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | -| **title_size** | **String** | Size of the title. | [optional] | -| **type** | [**CheckStatusWidgetDefinitionType**](CheckStatusWidgetDefinitionType.md) | | [default to 'check_status'] | +| Name | Type | Description | Notes | +| --------------- | ------------------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------- | +| **check** | **String** | Name of the check to use in the widget. | | +| **group** | **String** | Group reporting a single check. | [optional] | +| **group_by** | **Array<String>** | List of tag prefixes to group by in the case of a cluster check. | [optional] | +| **grouping** | [**WidgetGrouping**](WidgetGrouping.md) | | | +| **tags** | **Array<String>** | List of tags used to filter the groups reporting a cluster check. | [optional] | +| **time** | [**WidgetTime**](WidgetTime.md) | | [optional] | +| **title** | **String** | Title of the widget. | [optional] | +| **title_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | +| **title_size** | **String** | Size of the title. | [optional] | +| **type** | [**CheckStatusWidgetDefinitionType**](CheckStatusWidgetDefinitionType.md) | | [default to 'check_status'] | ## Example @@ -33,4 +33,3 @@ instance = DatadogAPIClient::V1::CheckStatusWidgetDefinition.new( type: null ) ``` - diff --git a/docs/v1/CheckStatusWidgetDefinitionType.md b/docs/v1/CheckStatusWidgetDefinitionType.md index d17dd24f8c44..30fadf7de5de 100644 --- a/docs/v1/CheckStatusWidgetDefinitionType.md +++ b/docs/v1/CheckStatusWidgetDefinitionType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::CheckStatusWidgetDefinitionType.new() ``` - diff --git a/docs/v1/ContentEncoding.md b/docs/v1/ContentEncoding.md index 7fd964cd486c..fee8f80d59f4 100644 --- a/docs/v1/ContentEncoding.md +++ b/docs/v1/ContentEncoding.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::ContentEncoding.new() ``` - diff --git a/docs/v1/Creator.md b/docs/v1/Creator.md index 5726c65e6a95..d2fd759f74ff 100644 --- a/docs/v1/Creator.md +++ b/docs/v1/Creator.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **email** | **String** | Email of the creator. | [optional] | +| Name | Type | Description | Notes | +| ---------- | ---------- | ---------------------- | ---------- | +| **email** | **String** | Email of the creator. | [optional] | | **handle** | **String** | Handle of the creator. | [optional] | -| **name** | **String** | Name of the creator. | [optional] | +| **name** | **String** | Name of the creator. | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::Creator.new( name: null ) ``` - diff --git a/docs/v1/Dashboard.md b/docs/v1/Dashboard.md index 42d2b8811bf2..1dcded9378aa 100644 --- a/docs/v1/Dashboard.md +++ b/docs/v1/Dashboard.md @@ -2,23 +2,23 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **author_handle** | **String** | Identifier of the dashboard author. | [optional][readonly] | -| **created_at** | **Time** | Creation date of the dashboard. | [optional][readonly] | -| **description** | **String** | Description of the dashboard. | [optional] | -| **id** | **String** | ID of the dashboard. | [optional][readonly] | -| **is_read_only** | **Boolean** | Whether this dashboard is read-only. If True, only the author and admins can make changes to it. | [optional][default to false] | -| **layout_type** | [**DashboardLayoutType**](DashboardLayoutType.md) | | | -| **modified_at** | **Time** | Modification date of the dashboard. | [optional][readonly] | -| **notify_list** | **Array<String>** | List of handles of users to notify when changes are made to this dashboard. | [optional] | -| **reflow_type** | [**DashboardReflowType**](DashboardReflowType.md) | | [optional] | -| **restricted_roles** | **Array<String>** | A list of role identifiers. Only the author and users associated with at least one of these roles can edit this dashboard. Overrides the `is_read_only` property if both are present. **This feature is currently in beta.** | [optional] | -| **template_variable_presets** | [**Array<DashboardTemplateVariablePreset>**](DashboardTemplateVariablePreset.md) | Array of template variables saved views. | [optional] | -| **template_variables** | [**Array<DashboardTemplateVariable>**](DashboardTemplateVariable.md) | List of template variables for this dashboard. | [optional] | -| **title** | **String** | Title of the dashboard. | | -| **url** | **String** | The URL of the dashboard. | [optional][readonly] | -| **widgets** | [**Array<Widget>**](Widget.md) | List of widgets to display on the dashboard. | | +| Name | Type | Description | Notes | +| ----------------------------- | -------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | +| **author_handle** | **String** | Identifier of the dashboard author. | [optional][readonly] | +| **created_at** | **Time** | Creation date of the dashboard. | [optional][readonly] | +| **description** | **String** | Description of the dashboard. | [optional] | +| **id** | **String** | ID of the dashboard. | [optional][readonly] | +| **is_read_only** | **Boolean** | Whether this dashboard is read-only. If True, only the author and admins can make changes to it. Prefer using `restricted_roles` to manage write authorization. | [optional][default to false] | +| **layout_type** | [**DashboardLayoutType**](DashboardLayoutType.md) | | | +| **modified_at** | **Time** | Modification date of the dashboard. | [optional][readonly] | +| **notify_list** | **Array<String>** | List of handles of users to notify when changes are made to this dashboard. | [optional] | +| **reflow_type** | [**DashboardReflowType**](DashboardReflowType.md) | | [optional] | +| **restricted_roles** | **Array<String>** | A list of role identifiers. Only the author and users associated with at least one of these roles can edit this dashboard. | [optional] | +| **template_variable_presets** | [**Array<DashboardTemplateVariablePreset>**](DashboardTemplateVariablePreset.md) | Array of template variables saved views. | [optional] | +| **template_variables** | [**Array<DashboardTemplateVariable>**](DashboardTemplateVariable.md) | List of template variables for this dashboard. | [optional] | +| **title** | **String** | Title of the dashboard. | | +| **url** | **String** | The URL of the dashboard. | [optional][readonly] | +| **widgets** | [**Array<Widget>**](Widget.md) | List of widgets to display on the dashboard. | | ## Example @@ -43,4 +43,3 @@ instance = DatadogAPIClient::V1::Dashboard.new( widgets: [{"definition":{"requests":{"fill":{"q":"system.cpu.user"}},"type":"hostmap"}}] ) ``` - diff --git a/docs/v1/DashboardBulkActionData.md b/docs/v1/DashboardBulkActionData.md index b2500d130f68..3fd0d2335e9c 100644 --- a/docs/v1/DashboardBulkActionData.md +++ b/docs/v1/DashboardBulkActionData.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **id** | **String** | Dashboard resource ID. | | -| **type** | [**DashboardResourceType**](DashboardResourceType.md) | | [default to 'dashboard'] | +| Name | Type | Description | Notes | +| -------- | ----------------------------------------------------- | ---------------------- | -------------------------------- | +| **id** | **String** | Dashboard resource ID. | | +| **type** | [**DashboardResourceType**](DashboardResourceType.md) | | [default to 'dashboard'] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::DashboardBulkActionData.new( type: null ) ``` - diff --git a/docs/v1/DashboardBulkDeleteRequest.md b/docs/v1/DashboardBulkDeleteRequest.md index bffc444a1306..ff7d9be224c9 100644 --- a/docs/v1/DashboardBulkDeleteRequest.md +++ b/docs/v1/DashboardBulkDeleteRequest.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**Array<DashboardBulkActionData>**](DashboardBulkActionData.md) | List of dashboard bulk action request data objects. | | +| Name | Type | Description | Notes | +| -------- | ---------------------------------------------------------------------- | --------------------------------------------------- | ----- | +| **data** | [**Array<DashboardBulkActionData>**](DashboardBulkActionData.md) | List of dashboard bulk action request data objects. | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::DashboardBulkDeleteRequest.new( data: [{"id":"123-abc-456","type":"dashboard"}] ) ``` - diff --git a/docs/v1/DashboardDeleteResponse.md b/docs/v1/DashboardDeleteResponse.md index 987f6e137cd1..fe4975d15d3d 100644 --- a/docs/v1/DashboardDeleteResponse.md +++ b/docs/v1/DashboardDeleteResponse.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| ------------------------ | ---------- | ---------------------------- | ---------- | | **deleted_dashboard_id** | **String** | ID of the deleted dashboard. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::DashboardDeleteResponse.new( deleted_dashboard_id: null ) ``` - diff --git a/docs/v1/DashboardLayoutType.md b/docs/v1/DashboardLayoutType.md index e84cc1bf19dc..ec8afbd9e17c 100644 --- a/docs/v1/DashboardLayoutType.md +++ b/docs/v1/DashboardLayoutType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::DashboardLayoutType.new() ``` - diff --git a/docs/v1/DashboardList.md b/docs/v1/DashboardList.md index ea4ca68643bb..94f2d517f2b5 100644 --- a/docs/v1/DashboardList.md +++ b/docs/v1/DashboardList.md @@ -2,16 +2,16 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **author** | [**Creator**](Creator.md) | | [optional] | -| **created** | **Time** | Date of creation of the dashboard list. | [optional][readonly] | -| **dashboard_count** | **Integer** | The number of dashboards in the list. | [optional][readonly] | -| **id** | **Integer** | The ID of the dashboard list. | [optional][readonly] | -| **is_favorite** | **Boolean** | Whether or not the list is in the favorites. | [optional][readonly] | -| **modified** | **Time** | Date of last edition of the dashboard list. | [optional][readonly] | -| **name** | **String** | The name of the dashboard list. | | -| **type** | **String** | The type of dashboard list. | [optional][readonly] | +| Name | Type | Description | Notes | +| ------------------- | ------------------------- | -------------------------------------------- | -------------------- | +| **author** | [**Creator**](Creator.md) | | [optional] | +| **created** | **Time** | Date of creation of the dashboard list. | [optional][readonly] | +| **dashboard_count** | **Integer** | The number of dashboards in the list. | [optional][readonly] | +| **id** | **Integer** | The ID of the dashboard list. | [optional][readonly] | +| **is_favorite** | **Boolean** | Whether or not the list is in the favorites. | [optional][readonly] | +| **modified** | **Time** | Date of last edition of the dashboard list. | [optional][readonly] | +| **name** | **String** | The name of the dashboard list. | | +| **type** | **String** | The type of dashboard list. | [optional][readonly] | ## Example @@ -29,4 +29,3 @@ instance = DatadogAPIClient::V1::DashboardList.new( type: manual_dashboard_list ) ``` - diff --git a/docs/v1/DashboardListDeleteResponse.md b/docs/v1/DashboardListDeleteResponse.md index 4f6664641fbe..0f6921cce0e3 100644 --- a/docs/v1/DashboardListDeleteResponse.md +++ b/docs/v1/DashboardListDeleteResponse.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| ----------------------------- | ----------- | --------------------------------- | ---------- | | **deleted_dashboard_list_id** | **Integer** | ID of the deleted dashboard list. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::DashboardListDeleteResponse.new( deleted_dashboard_list_id: null ) ``` - diff --git a/docs/v1/DashboardListListResponse.md b/docs/v1/DashboardListListResponse.md index 8c21cdeb073d..31e9f7c55436 100644 --- a/docs/v1/DashboardListListResponse.md +++ b/docs/v1/DashboardListListResponse.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| ------------------- | -------------------------------------------------- | --------------------------------- | ---------- | | **dashboard_lists** | [**Array<DashboardList>**](DashboardList.md) | List of all your dashboard lists. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::DashboardListListResponse.new( dashboard_lists: null ) ``` - diff --git a/docs/v1/DashboardListsAPI.md b/docs/v1/DashboardListsAPI.md index 7e602c65c327..c794d534731a 100644 --- a/docs/v1/DashboardListsAPI.md +++ b/docs/v1/DashboardListsAPI.md @@ -2,14 +2,13 @@ All URIs are relative to *https://api.datadoghq.com* -| Method | HTTP request | Description | -| ------ | ------------ | ----------- | -| [**create_dashboard_list**](DashboardListsAPI.md#create_dashboard_list) | **POST** /api/v1/dashboard/lists/manual | Create a dashboard list | +| Method | HTTP request | Description | +| ----------------------------------------------------------------------- | --------------------------------------------------- | ----------------------- | +| [**create_dashboard_list**](DashboardListsAPI.md#create_dashboard_list) | **POST** /api/v1/dashboard/lists/manual | Create a dashboard list | | [**delete_dashboard_list**](DashboardListsAPI.md#delete_dashboard_list) | **DELETE** /api/v1/dashboard/lists/manual/{list_id} | Delete a dashboard list | -| [**get_dashboard_list**](DashboardListsAPI.md#get_dashboard_list) | **GET** /api/v1/dashboard/lists/manual/{list_id} | Get a dashboard list | -| [**list_dashboard_lists**](DashboardListsAPI.md#list_dashboard_lists) | **GET** /api/v1/dashboard/lists/manual | Get all dashboard lists | -| [**update_dashboard_list**](DashboardListsAPI.md#update_dashboard_list) | **PUT** /api/v1/dashboard/lists/manual/{list_id} | Update a dashboard list | - +| [**get_dashboard_list**](DashboardListsAPI.md#get_dashboard_list) | **GET** /api/v1/dashboard/lists/manual/{list_id} | Get a dashboard list | +| [**list_dashboard_lists**](DashboardListsAPI.md#list_dashboard_lists) | **GET** /api/v1/dashboard/lists/manual | Get all dashboard lists | +| [**update_dashboard_list**](DashboardListsAPI.md#update_dashboard_list) | **PUT** /api/v1/dashboard/lists/manual/{list_id} | Update a dashboard list | ## create_dashboard_list @@ -53,9 +52,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**DashboardList**](DashboardList.md) | Create a dashboard list request body. | | +| Name | Type | Description | Notes | +| -------- | ------------------------------------- | ------------------------------------- | ----- | +| **body** | [**DashboardList**](DashboardList.md) | Create a dashboard list request body. | | ### Return type @@ -70,7 +69,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## delete_dashboard_list > delete_dashboard_list(list_id) @@ -113,9 +111,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **list_id** | **Integer** | ID of the dashboard list to delete. | | +| Name | Type | Description | Notes | +| ----------- | ----------- | ----------------------------------- | ----- | +| **list_id** | **Integer** | ID of the dashboard list to delete. | | ### Return type @@ -130,7 +128,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## get_dashboard_list > get_dashboard_list(list_id) @@ -173,9 +170,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **list_id** | **Integer** | ID of the dashboard list to fetch. | | +| Name | Type | Description | Notes | +| ----------- | ----------- | ---------------------------------- | ----- | +| **list_id** | **Integer** | ID of the dashboard list to fetch. | | ### Return type @@ -190,7 +187,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## list_dashboard_lists > list_dashboard_lists @@ -247,7 +243,6 @@ This endpoint does not need any parameter. - **Content-Type**: Not defined - **Accept**: application/json - ## update_dashboard_list > update_dashboard_list(list_id, body) @@ -291,10 +286,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **list_id** | **Integer** | ID of the dashboard list to update. | | -| **body** | [**DashboardList**](DashboardList.md) | Update a dashboard list request body. | | +| Name | Type | Description | Notes | +| ----------- | ------------------------------------- | ------------------------------------- | ----- | +| **list_id** | **Integer** | ID of the dashboard list to update. | | +| **body** | [**DashboardList**](DashboardList.md) | Update a dashboard list request body. | | ### Return type @@ -308,4 +303,3 @@ end - **Content-Type**: application/json - **Accept**: application/json - diff --git a/docs/v1/DashboardReflowType.md b/docs/v1/DashboardReflowType.md index c05f4537082c..0efc345ed1b8 100644 --- a/docs/v1/DashboardReflowType.md +++ b/docs/v1/DashboardReflowType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::DashboardReflowType.new() ``` - diff --git a/docs/v1/DashboardResourceType.md b/docs/v1/DashboardResourceType.md index deb526641894..f568d733467c 100644 --- a/docs/v1/DashboardResourceType.md +++ b/docs/v1/DashboardResourceType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::DashboardResourceType.new() ``` - diff --git a/docs/v1/DashboardRestoreRequest.md b/docs/v1/DashboardRestoreRequest.md index e2b3d6849245..f15319e206f8 100644 --- a/docs/v1/DashboardRestoreRequest.md +++ b/docs/v1/DashboardRestoreRequest.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**Array<DashboardBulkActionData>**](DashboardBulkActionData.md) | List of dashboard bulk action request data objects. | | +| Name | Type | Description | Notes | +| -------- | ---------------------------------------------------------------------- | --------------------------------------------------- | ----- | +| **data** | [**Array<DashboardBulkActionData>**](DashboardBulkActionData.md) | List of dashboard bulk action request data objects. | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::DashboardRestoreRequest.new( data: [{"id":"123-abc-456","type":"dashboard"}] ) ``` - diff --git a/docs/v1/DashboardSummary.md b/docs/v1/DashboardSummary.md index 04dfe7c2a106..dbef8e768420 100644 --- a/docs/v1/DashboardSummary.md +++ b/docs/v1/DashboardSummary.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| -------------- | ---------------------------------------------------------------------------- | ------------------------------ | ---------- | | **dashboards** | [**Array<DashboardSummaryDefinition>**](DashboardSummaryDefinition.md) | List of dashboard definitions. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::DashboardSummary.new( dashboards: null ) ``` - diff --git a/docs/v1/DashboardSummaryDefinition.md b/docs/v1/DashboardSummaryDefinition.md index c6fc0263fb8e..d65ab715f7ce 100644 --- a/docs/v1/DashboardSummaryDefinition.md +++ b/docs/v1/DashboardSummaryDefinition.md @@ -2,17 +2,17 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **author_handle** | **String** | Identifier of the dashboard author. | [optional] | -| **created_at** | **Time** | Creation date of the dashboard. | [optional] | -| **description** | **String** | Description of the dashboard. | [optional] | -| **id** | **String** | Dashboard identifier. | [optional] | -| **is_read_only** | **Boolean** | Whether this dashboard is read-only. If True, only the author and admins can make changes to it. | [optional] | -| **layout_type** | [**DashboardLayoutType**](DashboardLayoutType.md) | | [optional] | -| **modified_at** | **Time** | Modification date of the dashboard. | [optional] | -| **title** | **String** | Title of the dashboard. | [optional] | -| **url** | **String** | URL of the dashboard. | [optional] | +| Name | Type | Description | Notes | +| ----------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------------ | ---------- | +| **author_handle** | **String** | Identifier of the dashboard author. | [optional] | +| **created_at** | **Time** | Creation date of the dashboard. | [optional] | +| **description** | **String** | Description of the dashboard. | [optional] | +| **id** | **String** | Dashboard identifier. | [optional] | +| **is_read_only** | **Boolean** | Whether this dashboard is read-only. If True, only the author and admins can make changes to it. | [optional] | +| **layout_type** | [**DashboardLayoutType**](DashboardLayoutType.md) | | [optional] | +| **modified_at** | **Time** | Modification date of the dashboard. | [optional] | +| **title** | **String** | Title of the dashboard. | [optional] | +| **url** | **String** | URL of the dashboard. | [optional] | ## Example @@ -31,4 +31,3 @@ instance = DatadogAPIClient::V1::DashboardSummaryDefinition.new( url: null ) ``` - diff --git a/docs/v1/DashboardTemplateVariable.md b/docs/v1/DashboardTemplateVariable.md index 3df5cd68d71d..286859187320 100644 --- a/docs/v1/DashboardTemplateVariable.md +++ b/docs/v1/DashboardTemplateVariable.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **available_values** | **Array<String>** | The list of values that the template variable drop-down is limited to. | [optional] | -| **default** | **String** | The default value for the template variable on dashboard load. | [optional] | -| **name** | **String** | The name of the variable. | | -| **prefix** | **String** | The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down. | [optional] | +| Name | Type | Description | Notes | +| -------------------- | ----------------------- | --------------------------------------------------------------------------------------------------------- | ---------- | +| **available_values** | **Array<String>** | The list of values that the template variable drop-down is limited to. | [optional] | +| **default** | **String** | The default value for the template variable on dashboard load. | [optional] | +| **name** | **String** | The name of the variable. | | +| **prefix** | **String** | The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down. | [optional] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V1::DashboardTemplateVariable.new( prefix: host ) ``` - diff --git a/docs/v1/DashboardTemplateVariablePreset.md b/docs/v1/DashboardTemplateVariablePreset.md index a0735d93c869..decabbf523b9 100644 --- a/docs/v1/DashboardTemplateVariablePreset.md +++ b/docs/v1/DashboardTemplateVariablePreset.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **name** | **String** | The name of the variable. | [optional] | -| **template_variables** | [**Array<DashboardTemplateVariablePresetValue>**](DashboardTemplateVariablePresetValue.md) | List of variables. | [optional] | +| Name | Type | Description | Notes | +| ---------------------- | ------------------------------------------------------------------------------------------------ | ------------------------- | ---------- | +| **name** | **String** | The name of the variable. | [optional] | +| **template_variables** | [**Array<DashboardTemplateVariablePresetValue>**](DashboardTemplateVariablePresetValue.md) | List of variables. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::DashboardTemplateVariablePreset.new( template_variables: null ) ``` - diff --git a/docs/v1/DashboardTemplateVariablePresetValue.md b/docs/v1/DashboardTemplateVariablePresetValue.md index fc250df8284c..189062648524 100644 --- a/docs/v1/DashboardTemplateVariablePresetValue.md +++ b/docs/v1/DashboardTemplateVariablePresetValue.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **name** | **String** | The name of the variable. | [optional] | +| Name | Type | Description | Notes | +| --------- | ---------- | --------------------------------------------------------- | ---------- | +| **name** | **String** | The name of the variable. | [optional] | | **value** | **String** | The value of the template variable within the saved view. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::DashboardTemplateVariablePresetValue.new( value: null ) ``` - diff --git a/docs/v1/DashboardsAPI.md b/docs/v1/DashboardsAPI.md index e2839fd6b81c..66fda4c173b9 100644 --- a/docs/v1/DashboardsAPI.md +++ b/docs/v1/DashboardsAPI.md @@ -2,16 +2,15 @@ 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 @@ -56,9 +55,9 @@ 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 @@ -73,7 +72,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## delete_dashboard > delete_dashboard(dashboard_id) @@ -116,9 +114,9 @@ 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 @@ -133,7 +131,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## delete_dashboards > delete_dashboards(body) @@ -175,9 +172,9 @@ 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 @@ -192,7 +189,6 @@ nil (empty response body) - **Content-Type**: application/json - **Accept**: application/json - ## get_dashboard > get_dashboard(dashboard_id) @@ -235,9 +231,9 @@ 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 @@ -252,7 +248,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## list_dashboards > list_dashboards(opts) @@ -300,8 +295,8 @@ 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 @@ -317,7 +312,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## restore_dashboards > restore_dashboards(body) @@ -359,9 +353,9 @@ 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 @@ -376,7 +370,6 @@ nil (empty response body) - **Content-Type**: application/json - **Accept**: application/json - ## update_dashboard > update_dashboard(dashboard_id, body) @@ -420,10 +413,10 @@ 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 @@ -437,4 +430,3 @@ end - **Content-Type**: application/json - **Accept**: application/json - diff --git a/docs/v1/DeletedMonitor.md b/docs/v1/DeletedMonitor.md index f4c9b6f189cc..f74816c0cbe2 100644 --- a/docs/v1/DeletedMonitor.md +++ b/docs/v1/DeletedMonitor.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| ---------------------- | ----------- | -------------------------- | ---------- | | **deleted_monitor_id** | **Integer** | ID of the deleted monitor. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::DeletedMonitor.new( deleted_monitor_id: null ) ``` - diff --git a/docs/v1/DistributionWidgetDefinition.md b/docs/v1/DistributionWidgetDefinition.md index 0a2fcbd3bee3..c70176d517b1 100644 --- a/docs/v1/DistributionWidgetDefinition.md +++ b/docs/v1/DistributionWidgetDefinition.md @@ -2,19 +2,19 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **legend_size** | **String** | (Deprecated) The widget legend was replaced by a tooltip and sidebar. | [optional] | -| **markers** | [**Array<WidgetMarker>**](WidgetMarker.md) | List of markers. | [optional] | -| **requests** | [**Array<DistributionWidgetRequest>**](DistributionWidgetRequest.md) | Array of one request object to display in the widget. See the dedicated [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json) to learn how to build the `REQUEST_SCHEMA`. | | -| **show_legend** | **Boolean** | (Deprecated) The widget legend was replaced by a tooltip and sidebar. | [optional] | -| **time** | [**WidgetTime**](WidgetTime.md) | | [optional] | -| **title** | **String** | Title of the widget. | [optional] | -| **title_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | -| **title_size** | **String** | Size of the title. | [optional] | -| **type** | [**DistributionWidgetDefinitionType**](DistributionWidgetDefinitionType.md) | | [default to 'distribution'] | -| **xaxis** | [**DistributionWidgetXAxis**](DistributionWidgetXAxis.md) | | [optional] | -| **yaxis** | [**DistributionWidgetYAxis**](DistributionWidgetYAxis.md) | | [optional] | +| Name | Type | Description | Notes | +| --------------- | --------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | +| **legend_size** | **String** | (Deprecated) The widget legend was replaced by a tooltip and sidebar. | [optional] | +| **markers** | [**Array<WidgetMarker>**](WidgetMarker.md) | List of markers. | [optional] | +| **requests** | [**Array<DistributionWidgetRequest>**](DistributionWidgetRequest.md) | Array of one request object to display in the widget. See the dedicated [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json) to learn how to build the `REQUEST_SCHEMA`. | | +| **show_legend** | **Boolean** | (Deprecated) The widget legend was replaced by a tooltip and sidebar. | [optional] | +| **time** | [**WidgetTime**](WidgetTime.md) | | [optional] | +| **title** | **String** | Title of the widget. | [optional] | +| **title_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | +| **title_size** | **String** | Size of the title. | [optional] | +| **type** | [**DistributionWidgetDefinitionType**](DistributionWidgetDefinitionType.md) | | [default to 'distribution'] | +| **xaxis** | [**DistributionWidgetXAxis**](DistributionWidgetXAxis.md) | | [optional] | +| **yaxis** | [**DistributionWidgetYAxis**](DistributionWidgetYAxis.md) | | [optional] | ## Example @@ -35,4 +35,3 @@ instance = DatadogAPIClient::V1::DistributionWidgetDefinition.new( yaxis: null ) ``` - diff --git a/docs/v1/DistributionWidgetDefinitionType.md b/docs/v1/DistributionWidgetDefinitionType.md index 225946009155..1fff0cc38930 100644 --- a/docs/v1/DistributionWidgetDefinitionType.md +++ b/docs/v1/DistributionWidgetDefinitionType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::DistributionWidgetDefinitionType.new() ``` - diff --git a/docs/v1/DistributionWidgetRequest.md b/docs/v1/DistributionWidgetRequest.md index d2cf1ebd149f..d0f163829da9 100644 --- a/docs/v1/DistributionWidgetRequest.md +++ b/docs/v1/DistributionWidgetRequest.md @@ -2,19 +2,19 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **apm_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **apm_stats_query** | [**ApmStatsQueryDefinition**](ApmStatsQueryDefinition.md) | | [optional] | -| **event_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **log_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **network_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **process_query** | [**ProcessQueryDefinition**](ProcessQueryDefinition.md) | | [optional] | -| **profile_metrics_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **q** | **String** | Widget query. | [optional] | -| **rum_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **security_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **style** | [**WidgetStyle**](WidgetStyle.md) | | [optional] | +| Name | Type | Description | Notes | +| ------------------------- | --------------------------------------------------------- | ------------- | ---------- | +| **apm_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **apm_stats_query** | [**ApmStatsQueryDefinition**](ApmStatsQueryDefinition.md) | | [optional] | +| **event_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **log_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **network_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **process_query** | [**ProcessQueryDefinition**](ProcessQueryDefinition.md) | | [optional] | +| **profile_metrics_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **q** | **String** | Widget query. | [optional] | +| **rum_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **security_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **style** | [**WidgetStyle**](WidgetStyle.md) | | [optional] | ## Example @@ -35,4 +35,3 @@ instance = DatadogAPIClient::V1::DistributionWidgetRequest.new( style: null ) ``` - diff --git a/docs/v1/DistributionWidgetXAxis.md b/docs/v1/DistributionWidgetXAxis.md index 82c20e67b60f..8f04a54c3e28 100644 --- a/docs/v1/DistributionWidgetXAxis.md +++ b/docs/v1/DistributionWidgetXAxis.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **include_zero** | **Boolean** | True includes zero. | [optional] | -| **max** | **String** | Specifies maximum value to show on the x-axis. It takes a number, percentile (p90 === 90th percentile), or auto for default behavior. | [optional][default to 'auto'] | -| **min** | **String** | Specifies minimum value to show on the x-axis. It takes a number, percentile (p90 === 90th percentile), or auto for default behavior. | [optional][default to 'auto'] | -| **scale** | **String** | Specifies the scale type. Possible values are `linear`. | [optional][default to 'linear'] | +| Name | Type | Description | Notes | +| ---------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- | +| **include_zero** | **Boolean** | True includes zero. | [optional] | +| **max** | **String** | Specifies maximum value to show on the x-axis. It takes a number, percentile (p90 === 90th percentile), or auto for default behavior. | [optional][default to 'auto'] | +| **min** | **String** | Specifies minimum value to show on the x-axis. It takes a number, percentile (p90 === 90th percentile), or auto for default behavior. | [optional][default to 'auto'] | +| **scale** | **String** | Specifies the scale type. Possible values are `linear`. | [optional][default to 'linear'] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V1::DistributionWidgetXAxis.new( scale: null ) ``` - diff --git a/docs/v1/DistributionWidgetYAxis.md b/docs/v1/DistributionWidgetYAxis.md index be4916c26285..1799e5a159cb 100644 --- a/docs/v1/DistributionWidgetYAxis.md +++ b/docs/v1/DistributionWidgetYAxis.md @@ -2,13 +2,13 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **include_zero** | **Boolean** | True includes zero. | [optional] | -| **label** | **String** | The label of the axis to display on the graph. | [optional] | -| **max** | **String** | Specifies the maximum value to show on the y-axis. It takes a number, or auto for default behavior. | [optional][default to 'auto'] | -| **min** | **String** | Specifies minimum value to show on the y-axis. It takes a number, or auto for default behavior. | [optional][default to 'auto'] | -| **scale** | **String** | Specifies the scale type. Possible values are `linear` or `log`. | [optional][default to 'linear'] | +| Name | Type | Description | Notes | +| ---------------- | ----------- | --------------------------------------------------------------------------------------------------- | --------------------------------------- | +| **include_zero** | **Boolean** | True includes zero. | [optional] | +| **label** | **String** | The label of the axis to display on the graph. | [optional] | +| **max** | **String** | Specifies the maximum value to show on the y-axis. It takes a number, or auto for default behavior. | [optional][default to 'auto'] | +| **min** | **String** | Specifies minimum value to show on the y-axis. It takes a number, or auto for default behavior. | [optional][default to 'auto'] | +| **scale** | **String** | Specifies the scale type. Possible values are `linear` or `log`. | [optional][default to 'linear'] | ## Example @@ -23,4 +23,3 @@ instance = DatadogAPIClient::V1::DistributionWidgetYAxis.new( scale: null ) ``` - diff --git a/docs/v1/Downtime.md b/docs/v1/Downtime.md index 37100e1ccfdb..c1ebe0807d24 100644 --- a/docs/v1/Downtime.md +++ b/docs/v1/Downtime.md @@ -2,25 +2,25 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **active** | **Boolean** | If a scheduled downtime currently exists. | [optional][readonly] | -| **active_child** | [**DowntimeChild**](DowntimeChild.md) | | [optional] | -| **canceled** | **Integer** | If a scheduled downtime is canceled. | [optional][readonly] | -| **creator_id** | **Integer** | User ID of the downtime creator. | [optional][readonly] | -| **disabled** | **Boolean** | If a downtime has been disabled. | [optional] | -| **downtime_type** | **Integer** | `0` for a downtime applied on `*` or all, `1` when the downtime is only scoped to hosts, or `2` when the downtime is scoped to anything but hosts. | [optional][readonly] | -| **_end** | **Integer** | POSIX timestamp to end the downtime. If not provided, the downtime is in effect indefinitely until you cancel it. | [optional] | -| **id** | **Integer** | The downtime ID. | [optional][readonly] | -| **message** | **String** | A message to include with notifications for this downtime. Email notifications can be sent to specific users by using the same `@username` notation as events. | [optional] | -| **monitor_id** | **Integer** | A single monitor to which the downtime applies. If not provided, the downtime applies to all monitors. | [optional] | -| **monitor_tags** | **Array<String>** | A comma-separated list of monitor tags. For example, tags that are applied directly to monitors, not tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies. The resulting downtime applies to monitors that match ALL provided monitor tags. For example, `service:postgres` **AND** `team:frontend`. | [optional] | -| **parent_id** | **Integer** | ID of the parent Downtime. | [optional] | -| **recurrence** | [**DowntimeRecurrence**](DowntimeRecurrence.md) | | [optional] | -| **scope** | **Array<String>** | The scope(s) to which the downtime applies. For example, `host:app2`. Provide multiple scopes as a comma-separated list like `env:dev,env:prod`. The resulting downtime applies to sources that matches ALL provided scopes (`env:dev` **AND** `env:prod`). | [optional] | -| **start** | **Integer** | POSIX timestamp to start the downtime. If not provided, the downtime starts the moment it is created. | [optional] | -| **timezone** | **String** | The timezone in which to display the downtime's start and end times in Datadog applications. | [optional] | -| **updater_id** | **Integer** | ID of the last user that updated the downtime. | [optional][readonly] | +| Name | Type | Description | Notes | +| ----------------- | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------- | +| **active** | **Boolean** | If a scheduled downtime currently exists. | [optional][readonly] | +| **active_child** | [**DowntimeChild**](DowntimeChild.md) | | [optional] | +| **canceled** | **Integer** | If a scheduled downtime is canceled. | [optional][readonly] | +| **creator_id** | **Integer** | User ID of the downtime creator. | [optional][readonly] | +| **disabled** | **Boolean** | If a downtime has been disabled. | [optional] | +| **downtime_type** | **Integer** | `0` for a downtime applied on `\*` or all, `1` when the downtime is only scoped to hosts, or `2` when the downtime is scoped to anything but hosts. | [optional][readonly] | +| **\_end** | **Integer** | POSIX timestamp to end the downtime. If not provided, the downtime is in effect indefinitely until you cancel it. | [optional] | +| **id** | **Integer** | The downtime ID. | [optional][readonly] | +| **message** | **String** | A message to include with notifications for this downtime. Email notifications can be sent to specific users by using the same `@username` notation as events. | [optional] | +| **monitor_id** | **Integer** | A single monitor to which the downtime applies. If not provided, the downtime applies to all monitors. | [optional] | +| **monitor_tags** | **Array<String>** | A comma-separated list of monitor tags. For example, tags that are applied directly to monitors, not tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies. The resulting downtime applies to monitors that match ALL provided monitor tags. For example, `service:postgres` **AND** `team:frontend`. | [optional] | +| **parent_id** | **Integer** | ID of the parent Downtime. | [optional] | +| **recurrence** | [**DowntimeRecurrence**](DowntimeRecurrence.md) | | [optional] | +| **scope** | **Array<String>** | The scope(s) to which the downtime applies. For example, `host:app2`. Provide multiple scopes as a comma-separated list like `env:dev,env:prod`. The resulting downtime applies to sources that matches ALL provided scopes (`env:dev` **AND** `env:prod`). | [optional] | +| **start** | **Integer** | POSIX timestamp to start the downtime. If not provided, the downtime starts the moment it is created. | [optional] | +| **timezone** | **String** | The timezone in which to display the downtime's start and end times in Datadog applications. | [optional] | +| **updater_id** | **Integer** | ID of the last user that updated the downtime. | [optional][readonly] | ## Example @@ -47,4 +47,3 @@ instance = DatadogAPIClient::V1::Downtime.new( updater_id: 123456 ) ``` - diff --git a/docs/v1/DowntimeChild.md b/docs/v1/DowntimeChild.md index 351c3d8be548..712a279c0816 100644 --- a/docs/v1/DowntimeChild.md +++ b/docs/v1/DowntimeChild.md @@ -2,24 +2,24 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **active** | **Boolean** | If a scheduled downtime currently exists. | [optional][readonly] | -| **canceled** | **Integer** | If a scheduled downtime is canceled. | [optional][readonly] | -| **creator_id** | **Integer** | User ID of the downtime creator. | [optional][readonly] | -| **disabled** | **Boolean** | If a downtime has been disabled. | [optional] | -| **downtime_type** | **Integer** | `0` for a downtime applied on `*` or all, `1` when the downtime is only scoped to hosts, or `2` when the downtime is scoped to anything but hosts. | [optional][readonly] | -| **_end** | **Integer** | POSIX timestamp to end the downtime. If not provided, the downtime is in effect indefinitely until you cancel it. | [optional] | -| **id** | **Integer** | The downtime ID. | [optional][readonly] | -| **message** | **String** | A message to include with notifications for this downtime. Email notifications can be sent to specific users by using the same `@username` notation as events. | [optional] | -| **monitor_id** | **Integer** | A single monitor to which the downtime applies. If not provided, the downtime applies to all monitors. | [optional] | -| **monitor_tags** | **Array<String>** | A comma-separated list of monitor tags. For example, tags that are applied directly to monitors, not tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies. The resulting downtime applies to monitors that match ALL provided monitor tags. For example, `service:postgres` **AND** `team:frontend`. | [optional] | -| **parent_id** | **Integer** | ID of the parent Downtime. | [optional] | -| **recurrence** | [**DowntimeRecurrence**](DowntimeRecurrence.md) | | [optional] | -| **scope** | **Array<String>** | The scope(s) to which the downtime applies. For example, `host:app2`. Provide multiple scopes as a comma-separated list like `env:dev,env:prod`. The resulting downtime applies to sources that matches ALL provided scopes (`env:dev` **AND** `env:prod`). | [optional] | -| **start** | **Integer** | POSIX timestamp to start the downtime. If not provided, the downtime starts the moment it is created. | [optional] | -| **timezone** | **String** | The timezone in which to display the downtime's start and end times in Datadog applications. | [optional] | -| **updater_id** | **Integer** | ID of the last user that updated the downtime. | [optional][readonly] | +| Name | Type | Description | Notes | +| ----------------- | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------- | +| **active** | **Boolean** | If a scheduled downtime currently exists. | [optional][readonly] | +| **canceled** | **Integer** | If a scheduled downtime is canceled. | [optional][readonly] | +| **creator_id** | **Integer** | User ID of the downtime creator. | [optional][readonly] | +| **disabled** | **Boolean** | If a downtime has been disabled. | [optional] | +| **downtime_type** | **Integer** | `0` for a downtime applied on `\*` or all, `1` when the downtime is only scoped to hosts, or `2` when the downtime is scoped to anything but hosts. | [optional][readonly] | +| **\_end** | **Integer** | POSIX timestamp to end the downtime. If not provided, the downtime is in effect indefinitely until you cancel it. | [optional] | +| **id** | **Integer** | The downtime ID. | [optional][readonly] | +| **message** | **String** | A message to include with notifications for this downtime. Email notifications can be sent to specific users by using the same `@username` notation as events. | [optional] | +| **monitor_id** | **Integer** | A single monitor to which the downtime applies. If not provided, the downtime applies to all monitors. | [optional] | +| **monitor_tags** | **Array<String>** | A comma-separated list of monitor tags. For example, tags that are applied directly to monitors, not tags that are used in monitor queries (which are filtered by the scope parameter), to which the downtime applies. The resulting downtime applies to monitors that match ALL provided monitor tags. For example, `service:postgres` **AND** `team:frontend`. | [optional] | +| **parent_id** | **Integer** | ID of the parent Downtime. | [optional] | +| **recurrence** | [**DowntimeRecurrence**](DowntimeRecurrence.md) | | [optional] | +| **scope** | **Array<String>** | The scope(s) to which the downtime applies. For example, `host:app2`. Provide multiple scopes as a comma-separated list like `env:dev,env:prod`. The resulting downtime applies to sources that matches ALL provided scopes (`env:dev` **AND** `env:prod`). | [optional] | +| **start** | **Integer** | POSIX timestamp to start the downtime. If not provided, the downtime starts the moment it is created. | [optional] | +| **timezone** | **String** | The timezone in which to display the downtime's start and end times in Datadog applications. | [optional] | +| **updater_id** | **Integer** | ID of the last user that updated the downtime. | [optional][readonly] | ## Example @@ -45,4 +45,3 @@ instance = DatadogAPIClient::V1::DowntimeChild.new( updater_id: 123456 ) ``` - diff --git a/docs/v1/DowntimeRecurrence.md b/docs/v1/DowntimeRecurrence.md index 60d3f2124152..f3680c996e2d 100644 --- a/docs/v1/DowntimeRecurrence.md +++ b/docs/v1/DowntimeRecurrence.md @@ -2,14 +2,14 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **period** | **Integer** | How often to repeat as an integer. For example, to repeat every 3 days, select a type of `days` and a period of `3`. | [optional] | -| **rrule** | **String** | The `RRULE` standard for defining recurring events (**requires to set \"type\" to rrule**) For example, to have a recurring event on the first day of each month, set the type to `rrule` and set the `FREQ` to `MONTHLY` and `BYMONTHDAY` to `1`. Most common `rrule` options from the [iCalendar Spec](https://tools.ietf.org/html/rfc5545) are supported. **Note**: Attributes specifying the duration in `RRULE` are not supported (for example, `DTSTART`, `DTEND`, `DURATION`). More examples available in this [downtime guide](https://docs.datadoghq.com/monitors/guide/suppress-alert-with-downtimes/?tab=api) | [optional] | -| **type** | **String** | The type of recurrence. Choose from `days`, `weeks`, `months`, `years`, `rrule`. | [optional] | -| **until_date** | **Integer** | The date at which the recurrence should end as a POSIX timestamp. `until_occurences` and `until_date` are mutually exclusive. | [optional] | -| **until_occurrences** | **Integer** | How many times the downtime is rescheduled. `until_occurences` and `until_date` are mutually exclusive. | [optional] | -| **week_days** | **Array<String>** | A list of week days to repeat on. Choose from `Mon`, `Tue`, `Wed`, `Thu`, `Fri`, `Sat` or `Sun`. Only applicable when type is weeks. First letter must be capitalized. | [optional] | +| Name | Type | Description | Notes | +| --------------------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------- | +| **period** | **Integer** | How often to repeat as an integer. For example, to repeat every 3 days, select a type of `days` and a period of `3`. | [optional] | +| **rrule** | **String** | The `RRULE` standard for defining recurring events (**requires to set \"type\" to rrule**) For example, to have a recurring event on the first day of each month, set the type to `rrule` and set the `FREQ` to `MONTHLY` and `BYMONTHDAY` to `1`. Most common `rrule` options from the [iCalendar Spec](https://tools.ietf.org/html/rfc5545) are supported. **Note**: Attributes specifying the duration in `RRULE` are not supported (for example, `DTSTART`, `DTEND`, `DURATION`). More examples available in this [downtime guide](https://docs.datadoghq.com/monitors/guide/suppress-alert-with-downtimes/?tab=api) | [optional] | +| **type** | **String** | The type of recurrence. Choose from `days`, `weeks`, `months`, `years`, `rrule`. | [optional] | +| **until_date** | **Integer** | The date at which the recurrence should end as a POSIX timestamp. `until_occurences` and `until_date` are mutually exclusive. | [optional] | +| **until_occurrences** | **Integer** | How many times the downtime is rescheduled. `until_occurences` and `until_date` are mutually exclusive. | [optional] | +| **week_days** | **Array<String>** | A list of week days to repeat on. Choose from `Mon`, `Tue`, `Wed`, `Thu`, `Fri`, `Sat` or `Sun`. Only applicable when type is weeks. First letter must be capitalized. | [optional] | ## Example @@ -25,4 +25,3 @@ instance = DatadogAPIClient::V1::DowntimeRecurrence.new( week_days: ["Mon","Tue"] ) ``` - diff --git a/docs/v1/DowntimesAPI.md b/docs/v1/DowntimesAPI.md index 66b5f9ddd8a3..2890e6dc584c 100644 --- a/docs/v1/DowntimesAPI.md +++ b/docs/v1/DowntimesAPI.md @@ -2,16 +2,15 @@ All URIs are relative to *https://api.datadoghq.com* -| Method | HTTP request | Description | -| ------ | ------------ | ----------- | -| [**cancel_downtime**](DowntimesAPI.md#cancel_downtime) | **DELETE** /api/v1/downtime/{downtime_id} | Cancel a downtime | -| [**cancel_downtimes_by_scope**](DowntimesAPI.md#cancel_downtimes_by_scope) | **POST** /api/v1/downtime/cancel/by_scope | Cancel downtimes by scope | -| [**create_downtime**](DowntimesAPI.md#create_downtime) | **POST** /api/v1/downtime | Schedule a downtime | -| [**get_downtime**](DowntimesAPI.md#get_downtime) | **GET** /api/v1/downtime/{downtime_id} | Get a downtime | -| [**list_downtimes**](DowntimesAPI.md#list_downtimes) | **GET** /api/v1/downtime | Get all downtimes | -| [**list_monitor_downtimes**](DowntimesAPI.md#list_monitor_downtimes) | **GET** /api/v1/monitor/{monitor_id}/downtimes | Get all downtimes for a monitor | -| [**update_downtime**](DowntimesAPI.md#update_downtime) | **PUT** /api/v1/downtime/{downtime_id} | Update a downtime | - +| Method | HTTP request | Description | +| -------------------------------------------------------------------------- | ---------------------------------------------- | ------------------------------- | +| [**cancel_downtime**](DowntimesAPI.md#cancel_downtime) | **DELETE** /api/v1/downtime/{downtime_id} | Cancel a downtime | +| [**cancel_downtimes_by_scope**](DowntimesAPI.md#cancel_downtimes_by_scope) | **POST** /api/v1/downtime/cancel/by_scope | Cancel downtimes by scope | +| [**create_downtime**](DowntimesAPI.md#create_downtime) | **POST** /api/v1/downtime | Schedule a downtime | +| [**get_downtime**](DowntimesAPI.md#get_downtime) | **GET** /api/v1/downtime/{downtime_id} | Get a downtime | +| [**list_downtimes**](DowntimesAPI.md#list_downtimes) | **GET** /api/v1/downtime | Get all downtimes | +| [**list_monitor_downtimes**](DowntimesAPI.md#list_monitor_downtimes) | **GET** /api/v1/monitor/{monitor_id}/downtimes | Get all downtimes for a monitor | +| [**update_downtime**](DowntimesAPI.md#update_downtime) | **PUT** /api/v1/downtime/{downtime_id} | Update a downtime | ## cancel_downtime @@ -54,9 +53,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **downtime_id** | **Integer** | ID of the downtime to cancel. | | +| Name | Type | Description | Notes | +| --------------- | ----------- | ----------------------------- | ----- | +| **downtime_id** | **Integer** | ID of the downtime to cancel. | | ### Return type @@ -71,7 +70,6 @@ nil (empty response body) - **Content-Type**: Not defined - **Accept**: application/json - ## cancel_downtimes_by_scope > cancel_downtimes_by_scope(body) @@ -114,9 +112,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**CancelDowntimesByScopeRequest**](CancelDowntimesByScopeRequest.md) | Scope to cancel downtimes for. | | +| Name | Type | Description | Notes | +| -------- | --------------------------------------------------------------------- | ------------------------------ | ----- | +| **body** | [**CancelDowntimesByScopeRequest**](CancelDowntimesByScopeRequest.md) | Scope to cancel downtimes for. | | ### Return type @@ -131,7 +129,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## create_downtime > create_downtime(body) @@ -174,9 +171,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**Downtime**](Downtime.md) | Schedule a downtime request body. | | +| Name | Type | Description | Notes | +| -------- | --------------------------- | --------------------------------- | ----- | +| **body** | [**Downtime**](Downtime.md) | Schedule a downtime request body. | | ### Return type @@ -191,7 +188,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## get_downtime > get_downtime(downtime_id) @@ -234,9 +230,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **downtime_id** | **Integer** | ID of the downtime to fetch. | | +| Name | Type | Description | Notes | +| --------------- | ----------- | ---------------------------- | ----- | +| **downtime_id** | **Integer** | ID of the downtime to fetch. | | ### Return type @@ -251,7 +247,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## list_downtimes > > list_downtimes(opts) @@ -296,8 +291,8 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| ---------------- | ----------- | --------------------------------------------------------------- | ---------- | | **current_only** | **Boolean** | Only return downtimes that are active when the request is made. | [optional] | ### Return type @@ -313,7 +308,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## list_monitor_downtimes > > list_monitor_downtimes(monitor_id) @@ -356,9 +350,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **monitor_id** | **Integer** | The id of the monitor | | +| Name | Type | Description | Notes | +| -------------- | ----------- | --------------------- | ----- | +| **monitor_id** | **Integer** | The id of the monitor | | ### Return type @@ -373,7 +367,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## update_downtime > update_downtime(downtime_id, body) @@ -417,10 +410,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **downtime_id** | **Integer** | ID of the downtime to update. | | -| **body** | [**Downtime**](Downtime.md) | Update a downtime request body. | | +| Name | Type | Description | Notes | +| --------------- | --------------------------- | ------------------------------- | ----- | +| **downtime_id** | **Integer** | ID of the downtime to update. | | +| **body** | [**Downtime**](Downtime.md) | Update a downtime request body. | | ### Return type @@ -434,4 +427,3 @@ end - **Content-Type**: application/json - **Accept**: application/json - diff --git a/docs/v1/Event.md b/docs/v1/Event.md index 0d2f68841348..7775a96723b6 100644 --- a/docs/v1/Event.md +++ b/docs/v1/Event.md @@ -2,21 +2,21 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **alert_type** | [**EventAlertType**](EventAlertType.md) | | [optional] | -| **date_happened** | **Integer** | POSIX timestamp of the event. Must be sent as an integer (i.e. no quotes). Limited to events no older than 7 days. | [optional] | -| **device_name** | **String** | A device name. | [optional] | -| **host** | **String** | Host name to associate with the event. Any tags associated with the host are also applied to this event. | [optional] | -| **id** | **Integer** | Integer ID of the event. | [optional][readonly] | -| **id_str** | **String** | Handling IDs as large 64-bit numbers can cause loss of accuracy issues with some programming languages. Instead, use the string representation of the Event ID to avoid losing accuracy. | [optional][readonly] | -| **payload** | **String** | Payload of the event. | [optional][readonly] | -| **priority** | [**EventPriority**](EventPriority.md) | | [optional] | -| **source_type_name** | **String** | The type of event being posted. Option examples include nagios, hudson, jenkins, my_apps, chef, puppet, git, bitbucket, etc. A complete list of source attribute values [available here](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value). | [optional] | -| **tags** | **Array<String>** | A list of tags to apply to the event. | [optional] | -| **text** | **String** | The body of the event. Limited to 4000 characters. The text supports markdown. To use markdown in the event text, start the text block with `%%% \\n` and end the text block with `\\n %%%`. Use `msg_text` with the Datadog Ruby library. | [optional] | -| **title** | **String** | The event title. | [optional] | -| **url** | **String** | URL of the event. | [optional][readonly] | +| Name | Type | Description | Notes | +| -------------------- | --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- | +| **alert_type** | [**EventAlertType**](EventAlertType.md) | | [optional] | +| **date_happened** | **Integer** | POSIX timestamp of the event. Must be sent as an integer (i.e. no quotes). Limited to events no older than 7 days. | [optional] | +| **device_name** | **String** | A device name. | [optional] | +| **host** | **String** | Host name to associate with the event. Any tags associated with the host are also applied to this event. | [optional] | +| **id** | **Integer** | Integer ID of the event. | [optional][readonly] | +| **id_str** | **String** | Handling IDs as large 64-bit numbers can cause loss of accuracy issues with some programming languages. Instead, use the string representation of the Event ID to avoid losing accuracy. | [optional][readonly] | +| **payload** | **String** | Payload of the event. | [optional][readonly] | +| **priority** | [**EventPriority**](EventPriority.md) | | [optional] | +| **source_type_name** | **String** | The type of event being posted. Option examples include nagios, hudson, jenkins, my_apps, chef, puppet, git, bitbucket, etc. A complete list of source attribute values [available here](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value). | [optional] | +| **tags** | **Array<String>** | A list of tags to apply to the event. | [optional] | +| **text** | **String** | The body of the event. Limited to 4000 characters. The text supports markdown. To use markdown in the event text, start the text block with `%%% \\n` and end the text block with `\\n %%%`. Use `msg_text` with the Datadog Ruby library. | [optional] | +| **title** | **String** | The event title. | [optional] | +| **url** | **String** | URL of the event. | [optional][readonly] | ## Example @@ -39,4 +39,3 @@ instance = DatadogAPIClient::V1::Event.new( url: null ) ``` - diff --git a/docs/v1/EventAlertType.md b/docs/v1/EventAlertType.md index 01761b4ca1d6..883a0e059173 100644 --- a/docs/v1/EventAlertType.md +++ b/docs/v1/EventAlertType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::EventAlertType.new() ``` - diff --git a/docs/v1/EventCreateRequest.md b/docs/v1/EventCreateRequest.md index aff1839403df..f7b84fcf441b 100644 --- a/docs/v1/EventCreateRequest.md +++ b/docs/v1/EventCreateRequest.md @@ -2,22 +2,22 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **aggregation_key** | **String** | An arbitrary string to use for aggregation. Limited to 100 characters. If you specify a key, all events using that key are grouped together in the Event Stream. | [optional] | -| **alert_type** | [**EventAlertType**](EventAlertType.md) | | [optional] | -| **date_happened** | **Integer** | POSIX timestamp of the event. Must be sent as an integer (i.e. no quotes). Limited to events no older than 7 days. | [optional] | -| **device_name** | **String** | A device name. | [optional] | -| **host** | **String** | Host name to associate with the event. Any tags associated with the host are also applied to this event. | [optional] | -| **id** | **Integer** | Integer ID of the event. | [optional][readonly] | -| **payload** | **String** | Payload of the event. | [optional][readonly] | -| **priority** | [**EventPriority**](EventPriority.md) | | [optional] | -| **related_event_id** | **Integer** | ID of the parent event. Must be sent as an integer (i.e. no quotes). | [optional] | -| **source_type_name** | **String** | The type of event being posted. Option examples include nagios, hudson, jenkins, my_apps, chef, puppet, git, bitbucket, etc. A complete list of source attribute values [available here](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value). | [optional] | -| **tags** | **Array<String>** | A list of tags to apply to the event. | [optional] | -| **text** | **String** | The body of the event. Limited to 4000 characters. The text supports markdown. To use markdown in the event text, start the text block with `%%% \\n` and end the text block with `\\n %%%`. Use `msg_text` with the Datadog Ruby library. | | -| **title** | **String** | The event title. Limited to 100 characters. Use `msg_title` with the Datadog Ruby library. | | -| **url** | **String** | URL of the event. | [optional][readonly] | +| Name | Type | Description | Notes | +| -------------------- | --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- | +| **aggregation_key** | **String** | An arbitrary string to use for aggregation. Limited to 100 characters. If you specify a key, all events using that key are grouped together in the Event Stream. | [optional] | +| **alert_type** | [**EventAlertType**](EventAlertType.md) | | [optional] | +| **date_happened** | **Integer** | POSIX timestamp of the event. Must be sent as an integer (i.e. no quotes). Limited to events no older than 7 days. | [optional] | +| **device_name** | **String** | A device name. | [optional] | +| **host** | **String** | Host name to associate with the event. Any tags associated with the host are also applied to this event. | [optional] | +| **id** | **Integer** | Integer ID of the event. | [optional][readonly] | +| **payload** | **String** | Payload of the event. | [optional][readonly] | +| **priority** | [**EventPriority**](EventPriority.md) | | [optional] | +| **related_event_id** | **Integer** | ID of the parent event. Must be sent as an integer (i.e. no quotes). | [optional] | +| **source_type_name** | **String** | The type of event being posted. Option examples include nagios, hudson, jenkins, my_apps, chef, puppet, git, bitbucket, etc. A complete list of source attribute values [available here](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value). | [optional] | +| **tags** | **Array<String>** | A list of tags to apply to the event. | [optional] | +| **text** | **String** | The body of the event. Limited to 4000 characters. The text supports markdown. To use markdown in the event text, start the text block with `%%% \\n` and end the text block with `\\n %%%`. Use `msg_text` with the Datadog Ruby library. | | +| **title** | **String** | The event title. Limited to 100 characters. Use `msg_title` with the Datadog Ruby library. | | +| **url** | **String** | URL of the event. | [optional][readonly] | ## Example @@ -41,4 +41,3 @@ instance = DatadogAPIClient::V1::EventCreateRequest.new( url: null ) ``` - diff --git a/docs/v1/EventCreateResponse.md b/docs/v1/EventCreateResponse.md index b4de400c05b4..dee67a88c051 100644 --- a/docs/v1/EventCreateResponse.md +++ b/docs/v1/EventCreateResponse.md @@ -2,22 +2,22 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **alert_type** | [**EventAlertType**](EventAlertType.md) | | [optional] | -| **date_happened** | **Integer** | POSIX timestamp of the event. Must be sent as an integer (i.e. no quotes). Limited to events no older than 7 days. | [optional] | -| **device_name** | **String** | A device name. | [optional] | -| **host** | **String** | Host name to associate with the event. Any tags associated with the host are also applied to this event. | [optional] | -| **id** | **Integer** | Integer ID of the event. | [optional][readonly] | -| **payload** | **String** | Payload of the event. | [optional][readonly] | -| **priority** | [**EventPriority**](EventPriority.md) | | [optional] | -| **related_event_id** | **Integer** | ID of the parent event. Must be sent as an integer (i.e. no quotes). | [optional] | -| **source_type_name** | **String** | The type of event being posted. Option examples include nagios, hudson, jenkins, my_apps, chef, puppet, git, bitbucket, etc. A complete list of source attribute values [available here](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value). | [optional] | -| **status** | **String** | A status. | [optional] | -| **tags** | **Array<String>** | A list of tags to apply to the event. | [optional] | -| **text** | **String** | The body of the event. Limited to 4000 characters. The text supports markdown. Use `msg_text` with the Datadog Ruby library. | [optional] | -| **title** | **String** | The event title. Limited to 100 characters. Use `msg_title` with the Datadog Ruby library. | [optional] | -| **url** | **String** | URL of the event. | [optional][readonly] | +| Name | Type | Description | Notes | +| -------------------- | --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- | +| **alert_type** | [**EventAlertType**](EventAlertType.md) | | [optional] | +| **date_happened** | **Integer** | POSIX timestamp of the event. Must be sent as an integer (i.e. no quotes). Limited to events no older than 7 days. | [optional] | +| **device_name** | **String** | A device name. | [optional] | +| **host** | **String** | Host name to associate with the event. Any tags associated with the host are also applied to this event. | [optional] | +| **id** | **Integer** | Integer ID of the event. | [optional][readonly] | +| **payload** | **String** | Payload of the event. | [optional][readonly] | +| **priority** | [**EventPriority**](EventPriority.md) | | [optional] | +| **related_event_id** | **Integer** | ID of the parent event. Must be sent as an integer (i.e. no quotes). | [optional] | +| **source_type_name** | **String** | The type of event being posted. Option examples include nagios, hudson, jenkins, my_apps, chef, puppet, git, bitbucket, etc. A complete list of source attribute values [available here](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value). | [optional] | +| **status** | **String** | A status. | [optional] | +| **tags** | **Array<String>** | A list of tags to apply to the event. | [optional] | +| **text** | **String** | The body of the event. Limited to 4000 characters. The text supports markdown. Use `msg_text` with the Datadog Ruby library. | [optional] | +| **title** | **String** | The event title. Limited to 100 characters. Use `msg_title` with the Datadog Ruby library. | [optional] | +| **url** | **String** | URL of the event. | [optional][readonly] | ## Example @@ -41,4 +41,3 @@ instance = DatadogAPIClient::V1::EventCreateResponse.new( url: null ) ``` - diff --git a/docs/v1/EventListResponse.md b/docs/v1/EventListResponse.md index 017eaa6702a7..255c4d789080 100644 --- a/docs/v1/EventListResponse.md +++ b/docs/v1/EventListResponse.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| ---------- | ---------------------------------- | ------------------- | ---------- | | **events** | [**Array<Event>**](Event.md) | An array of events. | [optional] | -| **status** | **String** | A status. | [optional] | +| **status** | **String** | A status. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::EventListResponse.new( status: null ) ``` - diff --git a/docs/v1/EventPriority.md b/docs/v1/EventPriority.md index c5661587c059..1a4433e5a026 100644 --- a/docs/v1/EventPriority.md +++ b/docs/v1/EventPriority.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::EventPriority.new() ``` - diff --git a/docs/v1/EventQueryDefinition.md b/docs/v1/EventQueryDefinition.md index 6053fb684daf..51cbe788e772 100644 --- a/docs/v1/EventQueryDefinition.md +++ b/docs/v1/EventQueryDefinition.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **search** | **String** | The query being made on the event. | | -| **tags_execution** | **String** | The execution method for multi-value filters. Can be either and or or. | | +| Name | Type | Description | Notes | +| ------------------ | ---------- | ---------------------------------------------------------------------- | ----- | +| **search** | **String** | The query being made on the event. | | +| **tags_execution** | **String** | The execution method for multi-value filters. Can be either and or or. | | ## Example @@ -14,7 +14,6 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::EventQueryDefinition.new( search: , - tags_execution: + tags_execution: ) ``` - diff --git a/docs/v1/EventResponse.md b/docs/v1/EventResponse.md index 961448700afd..5810a4ea8ce6 100644 --- a/docs/v1/EventResponse.md +++ b/docs/v1/EventResponse.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **event** | [**Event**](Event.md) | | [optional] | -| **status** | **String** | A status. | [optional] | +| Name | Type | Description | Notes | +| ---------- | --------------------- | ----------- | ---------- | +| **event** | [**Event**](Event.md) | | [optional] | +| **status** | **String** | A status. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::EventResponse.new( status: null ) ``` - diff --git a/docs/v1/EventStreamWidgetDefinition.md b/docs/v1/EventStreamWidgetDefinition.md index 4f68dc52445c..46e3458cd0ba 100644 --- a/docs/v1/EventStreamWidgetDefinition.md +++ b/docs/v1/EventStreamWidgetDefinition.md @@ -2,16 +2,16 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **event_size** | [**WidgetEventSize**](WidgetEventSize.md) | | [optional] | -| **query** | **String** | Query to filter the event stream with. | | -| **tags_execution** | **String** | The execution method for multi-value filters. Can be either and or or. | [optional] | -| **time** | [**WidgetTime**](WidgetTime.md) | | [optional] | -| **title** | **String** | Title of the widget. | [optional] | -| **title_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | -| **title_size** | **String** | Size of the title. | [optional] | -| **type** | [**EventStreamWidgetDefinitionType**](EventStreamWidgetDefinitionType.md) | | [default to 'event_stream'] | +| Name | Type | Description | Notes | +| ------------------ | ------------------------------------------------------------------------- | ---------------------------------------------------------------------- | ----------------------------------- | +| **event_size** | [**WidgetEventSize**](WidgetEventSize.md) | | [optional] | +| **query** | **String** | Query to filter the event stream with. | | +| **tags_execution** | **String** | The execution method for multi-value filters. Can be either and or or. | [optional] | +| **time** | [**WidgetTime**](WidgetTime.md) | | [optional] | +| **title** | **String** | Title of the widget. | [optional] | +| **title_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | +| **title_size** | **String** | Size of the title. | [optional] | +| **type** | [**EventStreamWidgetDefinitionType**](EventStreamWidgetDefinitionType.md) | | [default to 'event_stream'] | ## Example @@ -29,4 +29,3 @@ instance = DatadogAPIClient::V1::EventStreamWidgetDefinition.new( type: null ) ``` - diff --git a/docs/v1/EventStreamWidgetDefinitionType.md b/docs/v1/EventStreamWidgetDefinitionType.md index ddf605f95dc8..a53f643f73a1 100644 --- a/docs/v1/EventStreamWidgetDefinitionType.md +++ b/docs/v1/EventStreamWidgetDefinitionType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::EventStreamWidgetDefinitionType.new() ``` - diff --git a/docs/v1/EventTimelineWidgetDefinition.md b/docs/v1/EventTimelineWidgetDefinition.md index 73d1a9332942..6daa0128054d 100644 --- a/docs/v1/EventTimelineWidgetDefinition.md +++ b/docs/v1/EventTimelineWidgetDefinition.md @@ -2,15 +2,15 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **query** | **String** | Query to filter the event timeline with. | | -| **tags_execution** | **String** | The execution method for multi-value filters. Can be either and or or. | [optional] | -| **time** | [**WidgetTime**](WidgetTime.md) | | [optional] | -| **title** | **String** | Title of the widget. | [optional] | -| **title_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | -| **title_size** | **String** | Size of the title. | [optional] | -| **type** | [**EventTimelineWidgetDefinitionType**](EventTimelineWidgetDefinitionType.md) | | [default to 'event_timeline'] | +| Name | Type | Description | Notes | +| ------------------ | ----------------------------------------------------------------------------- | ---------------------------------------------------------------------- | ------------------------------------- | +| **query** | **String** | Query to filter the event timeline with. | | +| **tags_execution** | **String** | The execution method for multi-value filters. Can be either and or or. | [optional] | +| **time** | [**WidgetTime**](WidgetTime.md) | | [optional] | +| **title** | **String** | Title of the widget. | [optional] | +| **title_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | +| **title_size** | **String** | Size of the title. | [optional] | +| **type** | [**EventTimelineWidgetDefinitionType**](EventTimelineWidgetDefinitionType.md) | | [default to 'event_timeline'] | ## Example @@ -27,4 +27,3 @@ instance = DatadogAPIClient::V1::EventTimelineWidgetDefinition.new( type: null ) ``` - diff --git a/docs/v1/EventTimelineWidgetDefinitionType.md b/docs/v1/EventTimelineWidgetDefinitionType.md index 6967d7996e7a..152139a3ee74 100644 --- a/docs/v1/EventTimelineWidgetDefinitionType.md +++ b/docs/v1/EventTimelineWidgetDefinitionType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::EventTimelineWidgetDefinitionType.new() ``` - diff --git a/docs/v1/EventsAPI.md b/docs/v1/EventsAPI.md index 9cc3254045cd..0c8243e062e8 100644 --- a/docs/v1/EventsAPI.md +++ b/docs/v1/EventsAPI.md @@ -2,12 +2,11 @@ All URIs are relative to *https://api.datadoghq.com* -| Method | HTTP request | Description | -| ------ | ------------ | ----------- | -| [**create_event**](EventsAPI.md#create_event) | **POST** /api/v1/events | Post an event | -| [**get_event**](EventsAPI.md#get_event) | **GET** /api/v1/events/{event_id} | Get an event | -| [**list_events**](EventsAPI.md#list_events) | **GET** /api/v1/events | Query the event stream | - +| Method | HTTP request | Description | +| --------------------------------------------- | --------------------------------- | ---------------------- | +| [**create_event**](EventsAPI.md#create_event) | **POST** /api/v1/events | Post an event | +| [**get_event**](EventsAPI.md#get_event) | **GET** /api/v1/events/{event_id} | Get an event | +| [**list_events**](EventsAPI.md#list_events) | **GET** /api/v1/events | Query the event stream | ## create_event @@ -52,9 +51,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**EventCreateRequest**](EventCreateRequest.md) | Event request object | | +| Name | Type | Description | Notes | +| -------- | ----------------------------------------------- | -------------------- | ----- | +| **body** | [**EventCreateRequest**](EventCreateRequest.md) | Event request object | | ### Return type @@ -69,7 +68,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## get_event > get_event(event_id) @@ -115,9 +113,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **event_id** | **Integer** | The ID of the event. | | +| Name | Type | Description | Notes | +| ------------ | ----------- | -------------------- | ----- | +| **event_id** | **Integer** | The ID of the event. | | ### Return type @@ -132,20 +130,20 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## list_events -> list_events(start, _end, opts) +> list_events(start, \_end, opts) The event stream can be queried and filtered by time, priority, sources and tags. **Notes**: + - If the event you’re querying contains markdown formatting of any kind, -you may see characters such as `%`,`\`,`n` in your output. + you may see characters such as `%`,`\`,`n` in your output. - This endpoint returns a maximum of `1000` most recent results. To return additional results, -identify the last timestamp of the last result and set that as the `end` query time to -paginate the results. You can also use the page parameter to specify which set of `1000` results to return. + identify the last timestamp of the last result and set that as the `end` query time to + paginate the results. You can also use the page parameter to specify which set of `1000` results to return. ### Examples @@ -176,7 +174,7 @@ end This returns an Array which contains the response data, status code and headers. -> , Integer, Hash)> list_events_with_http_info(start, _end, opts) +> , Integer, Hash)> list_events_with_http_info(start, \_end, opts) ```ruby begin @@ -192,16 +190,16 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **start** | **Integer** | POSIX timestamp. | | -| **_end** | **Integer** | POSIX timestamp. | | -| **priority** | **EventPriority** | Priority of your events, either `low` or `normal`. | [optional] | -| **sources** | **String** | A comma separated string of sources. | [optional] | -| **tags** | **String** | A comma separated list indicating what tags, if any, should be used to filter the list of monitors by scope. | [optional] | -| **unaggregated** | **Boolean** | Set unaggregated to `true` to return all events within the specified [`start`,`end`] timeframe. Otherwise if an event is aggregated to a parent event with a timestamp outside of the timeframe, it won't be available in the output. Aggregated events with `is_aggregate=true` in the response will still be returned unless exclude_aggregate is set to `true.` | [optional] | -| **exclude_aggregate** | **Boolean** | Set `exclude_aggregate` to `true` to only return unaggregated events where `is_aggregate=false` in the response. If the `exclude_aggregate` parameter is set to `true`, then the unaggregated parameter is ignored and will be `true` by default. | [optional] | -| **page** | **Integer** | By default 1000 results are returned per request. Set page to the number of the page to return with `0` being the first page. The page parameter can only be used when either unaggregated or exclude_aggregate is set to `true.` | [optional] | +| Name | Type | Description | Notes | +| --------------------- | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **start** | **Integer** | POSIX timestamp. | | +| **\_end** | **Integer** | POSIX timestamp. | | +| **priority** | **EventPriority** | Priority of your events, either `low` or `normal`. | [optional] | +| **sources** | **String** | A comma separated string of sources. | [optional] | +| **tags** | **String** | A comma separated list indicating what tags, if any, should be used to filter the list of monitors by scope. | [optional] | +| **unaggregated** | **Boolean** | Set unaggregated to `true` to return all events within the specified [`start`,`end`] timeframe. Otherwise if an event is aggregated to a parent event with a timestamp outside of the timeframe, it won't be available in the output. Aggregated events with `is_aggregate=true` in the response will still be returned unless exclude_aggregate is set to `true.` | [optional] | +| **exclude_aggregate** | **Boolean** | Set `exclude_aggregate` to `true` to only return unaggregated events where `is_aggregate=false` in the response. If the `exclude_aggregate` parameter is set to `true`, then the unaggregated parameter is ignored and will be `true` by default. | [optional] | +| **page** | **Integer** | By default 1000 results are returned per request. Set page to the number of the page to return with `0` being the first page. The page parameter can only be used when either unaggregated or exclude_aggregate is set to `true.` | [optional] | ### Return type @@ -215,4 +213,3 @@ end - **Content-Type**: Not defined - **Accept**: application/json - diff --git a/docs/v1/FormulaAndFunctionApmDependencyStatName.md b/docs/v1/FormulaAndFunctionApmDependencyStatName.md index 4418eb0f5b5c..b3e4a6b7aad9 100644 --- a/docs/v1/FormulaAndFunctionApmDependencyStatName.md +++ b/docs/v1/FormulaAndFunctionApmDependencyStatName.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::FormulaAndFunctionApmDependencyStatName.new() ``` - diff --git a/docs/v1/FormulaAndFunctionApmDependencyStatsDataSource.md b/docs/v1/FormulaAndFunctionApmDependencyStatsDataSource.md index 17b71a3b19c9..73431de2d4fb 100644 --- a/docs/v1/FormulaAndFunctionApmDependencyStatsDataSource.md +++ b/docs/v1/FormulaAndFunctionApmDependencyStatsDataSource.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::FormulaAndFunctionApmDependencyStatsDataSource.new() ``` - diff --git a/docs/v1/FormulaAndFunctionApmDependencyStatsQueryDefinition.md b/docs/v1/FormulaAndFunctionApmDependencyStatsQueryDefinition.md index b9fda2ddff85..5a5f1b935d38 100644 --- a/docs/v1/FormulaAndFunctionApmDependencyStatsQueryDefinition.md +++ b/docs/v1/FormulaAndFunctionApmDependencyStatsQueryDefinition.md @@ -2,18 +2,18 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data_source** | [**FormulaAndFunctionApmDependencyStatsDataSource**](FormulaAndFunctionApmDependencyStatsDataSource.md) | | | -| **env** | **String** | APM environment. | | -| **is_upstream** | **Boolean** | Determines whether stats for upstream or downstream dependencies should be queried. | [optional] | -| **name** | **String** | Name of query to use in formulas. | | -| **operation_name** | **String** | Name of operation on service. | | -| **primary_tag_name** | **String** | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog. | [optional] | -| **primary_tag_value** | **String** | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | [optional] | -| **resource_name** | **String** | APM resource. | | -| **service** | **String** | APM service. | | -| **stat** | [**FormulaAndFunctionApmDependencyStatName**](FormulaAndFunctionApmDependencyStatName.md) | | | +| Name | Type | Description | Notes | +| --------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------- | +| **data_source** | [**FormulaAndFunctionApmDependencyStatsDataSource**](FormulaAndFunctionApmDependencyStatsDataSource.md) | | | +| **env** | **String** | APM environment. | | +| **is_upstream** | **Boolean** | Determines whether stats for upstream or downstream dependencies should be queried. | [optional] | +| **name** | **String** | Name of query to use in formulas. | | +| **operation_name** | **String** | Name of operation on service. | | +| **primary_tag_name** | **String** | The name of the second primary tag used within APM; required when `primary_tag_value` is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog. | [optional] | +| **primary_tag_value** | **String** | Filter APM data by the second primary tag. `primary_tag_name` must also be specified. | [optional] | +| **resource_name** | **String** | APM resource. | | +| **service** | **String** | APM service. | | +| **stat** | [**FormulaAndFunctionApmDependencyStatName**](FormulaAndFunctionApmDependencyStatName.md) | | | ## Example @@ -33,4 +33,3 @@ instance = DatadogAPIClient::V1::FormulaAndFunctionApmDependencyStatsQueryDefini stat: null ) ``` - diff --git a/docs/v1/FormulaAndFunctionApmResourceStatName.md b/docs/v1/FormulaAndFunctionApmResourceStatName.md index a9676b70a3cb..a35dc99f6b97 100644 --- a/docs/v1/FormulaAndFunctionApmResourceStatName.md +++ b/docs/v1/FormulaAndFunctionApmResourceStatName.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::FormulaAndFunctionApmResourceStatName.new() ``` - diff --git a/docs/v1/FormulaAndFunctionApmResourceStatsDataSource.md b/docs/v1/FormulaAndFunctionApmResourceStatsDataSource.md index 54d174ee4e0a..208796cd74f7 100644 --- a/docs/v1/FormulaAndFunctionApmResourceStatsDataSource.md +++ b/docs/v1/FormulaAndFunctionApmResourceStatsDataSource.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::FormulaAndFunctionApmResourceStatsDataSource.new() ``` - diff --git a/docs/v1/FormulaAndFunctionApmResourceStatsQueryDefinition.md b/docs/v1/FormulaAndFunctionApmResourceStatsQueryDefinition.md index 613ea3fa4cb0..5c40b9b4dce5 100644 --- a/docs/v1/FormulaAndFunctionApmResourceStatsQueryDefinition.md +++ b/docs/v1/FormulaAndFunctionApmResourceStatsQueryDefinition.md @@ -2,18 +2,18 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data_source** | [**FormulaAndFunctionApmResourceStatsDataSource**](FormulaAndFunctionApmResourceStatsDataSource.md) | | | -| **env** | **String** | APM environment. | | -| **group_by** | **Array<String>** | Array of fields to group results by. | [optional] | -| **name** | **String** | Name of this query to use in formulas. | | -| **operation_name** | **String** | Name of operation on service. | [optional] | -| **primary_tag_name** | **String** | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog | [optional] | -| **primary_tag_value** | **String** | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | [optional] | -| **resource_name** | **String** | APM resource name. | [optional] | -| **service** | **String** | APM service name. | | -| **stat** | [**FormulaAndFunctionApmResourceStatName**](FormulaAndFunctionApmResourceStatName.md) | | | +| Name | Type | Description | Notes | +| --------------------- | --------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **data_source** | [**FormulaAndFunctionApmResourceStatsDataSource**](FormulaAndFunctionApmResourceStatsDataSource.md) | | | +| **env** | **String** | APM environment. | | +| **group_by** | **Array<String>** | Array of fields to group results by. | [optional] | +| **name** | **String** | Name of this query to use in formulas. | | +| **operation_name** | **String** | Name of operation on service. | [optional] | +| **primary_tag_name** | **String** | Name of the second primary tag used within APM. Required when `primary_tag_value` is specified. See https://docs.datadoghq.com/tracing/guide/setting_primary_tags_to_scope/#add-a-second-primary-tag-in-datadog | [optional] | +| **primary_tag_value** | **String** | Value of the second primary tag by which to filter APM data. `primary_tag_name` must also be specified. | [optional] | +| **resource_name** | **String** | APM resource name. | [optional] | +| **service** | **String** | APM service name. | | +| **stat** | [**FormulaAndFunctionApmResourceStatName**](FormulaAndFunctionApmResourceStatName.md) | | | ## Example @@ -33,4 +33,3 @@ instance = DatadogAPIClient::V1::FormulaAndFunctionApmResourceStatsQueryDefiniti stat: null ) ``` - diff --git a/docs/v1/FormulaAndFunctionEventAggregation.md b/docs/v1/FormulaAndFunctionEventAggregation.md index 007c9f585dd3..cb5e63184ac3 100644 --- a/docs/v1/FormulaAndFunctionEventAggregation.md +++ b/docs/v1/FormulaAndFunctionEventAggregation.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::FormulaAndFunctionEventAggregation.new() ``` - diff --git a/docs/v1/FormulaAndFunctionEventQueryDefinition.md b/docs/v1/FormulaAndFunctionEventQueryDefinition.md index 7204beceb057..588b4de96d72 100644 --- a/docs/v1/FormulaAndFunctionEventQueryDefinition.md +++ b/docs/v1/FormulaAndFunctionEventQueryDefinition.md @@ -2,14 +2,14 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **compute** | [**FormulaAndFunctionEventQueryDefinitionCompute**](FormulaAndFunctionEventQueryDefinitionCompute.md) | | | -| **data_source** | [**FormulaAndFunctionEventsDataSource**](FormulaAndFunctionEventsDataSource.md) | | | -| **group_by** | [**Array<FormulaAndFunctionEventQueryGroupBy>**](FormulaAndFunctionEventQueryGroupBy.md) | Group by options. | [optional] | -| **indexes** | **Array<String>** | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | [optional] | -| **name** | **String** | Name of the query for use in formulas. | | -| **search** | [**FormulaAndFunctionEventQueryDefinitionSearch**](FormulaAndFunctionEventQueryDefinitionSearch.md) | | [optional] | +| Name | Type | Description | Notes | +| --------------- | ----------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | ---------- | +| **compute** | [**FormulaAndFunctionEventQueryDefinitionCompute**](FormulaAndFunctionEventQueryDefinitionCompute.md) | | | +| **data_source** | [**FormulaAndFunctionEventsDataSource**](FormulaAndFunctionEventsDataSource.md) | | | +| **group_by** | [**Array<FormulaAndFunctionEventQueryGroupBy>**](FormulaAndFunctionEventQueryGroupBy.md) | Group by options. | [optional] | +| **indexes** | **Array<String>** | An array of index names to query in the stream. Omit or use `[]` to query all indexes at once. | [optional] | +| **name** | **String** | Name of the query for use in formulas. | | +| **search** | [**FormulaAndFunctionEventQueryDefinitionSearch**](FormulaAndFunctionEventQueryDefinitionSearch.md) | | [optional] | ## Example @@ -25,4 +25,3 @@ instance = DatadogAPIClient::V1::FormulaAndFunctionEventQueryDefinition.new( search: null ) ``` - diff --git a/docs/v1/FormulaAndFunctionEventQueryDefinitionCompute.md b/docs/v1/FormulaAndFunctionEventQueryDefinitionCompute.md index 126f44f2fcb4..7d959170ff47 100644 --- a/docs/v1/FormulaAndFunctionEventQueryDefinitionCompute.md +++ b/docs/v1/FormulaAndFunctionEventQueryDefinitionCompute.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **aggregation** | [**FormulaAndFunctionEventAggregation**](FormulaAndFunctionEventAggregation.md) | | | -| **interval** | **Integer** | A time interval in milliseconds. | [optional] | -| **metric** | **String** | Measurable attribute to compute. | [optional] | +| Name | Type | Description | Notes | +| --------------- | ------------------------------------------------------------------------------- | -------------------------------- | ---------- | +| **aggregation** | [**FormulaAndFunctionEventAggregation**](FormulaAndFunctionEventAggregation.md) | | | +| **interval** | **Integer** | A time interval in milliseconds. | [optional] | +| **metric** | **String** | Measurable attribute to compute. | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::FormulaAndFunctionEventQueryDefinitionCompute.n metric: @duration ) ``` - diff --git a/docs/v1/FormulaAndFunctionEventQueryDefinitionSearch.md b/docs/v1/FormulaAndFunctionEventQueryDefinitionSearch.md index 9d780da2e484..31d9c3ab8be8 100644 --- a/docs/v1/FormulaAndFunctionEventQueryDefinitionSearch.md +++ b/docs/v1/FormulaAndFunctionEventQueryDefinitionSearch.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **query** | **String** | Events search string. | | +| Name | Type | Description | Notes | +| --------- | ---------- | --------------------- | ----- | +| **query** | **String** | Events search string. | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::FormulaAndFunctionEventQueryDefinitionSearch.ne query: service:query ) ``` - diff --git a/docs/v1/FormulaAndFunctionEventQueryGroupBy.md b/docs/v1/FormulaAndFunctionEventQueryGroupBy.md index 25284791a151..6329e71c487b 100644 --- a/docs/v1/FormulaAndFunctionEventQueryGroupBy.md +++ b/docs/v1/FormulaAndFunctionEventQueryGroupBy.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **facet** | **String** | Event facet. | | -| **limit** | **Integer** | Number of groups to return. | [optional] | -| **sort** | [**FormulaAndFunctionEventQueryGroupBySort**](FormulaAndFunctionEventQueryGroupBySort.md) | | [optional] | +| Name | Type | Description | Notes | +| --------- | ----------------------------------------------------------------------------------------- | --------------------------- | ---------- | +| **facet** | **String** | Event facet. | | +| **limit** | **Integer** | Number of groups to return. | [optional] | +| **sort** | [**FormulaAndFunctionEventQueryGroupBySort**](FormulaAndFunctionEventQueryGroupBySort.md) | | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::FormulaAndFunctionEventQueryGroupBy.new( sort: null ) ``` - diff --git a/docs/v1/FormulaAndFunctionEventQueryGroupBySort.md b/docs/v1/FormulaAndFunctionEventQueryGroupBySort.md index 6b7505ada8ad..1530ae7752cd 100644 --- a/docs/v1/FormulaAndFunctionEventQueryGroupBySort.md +++ b/docs/v1/FormulaAndFunctionEventQueryGroupBySort.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **aggregation** | [**FormulaAndFunctionEventAggregation**](FormulaAndFunctionEventAggregation.md) | | | -| **metric** | **String** | Metric used for sorting group by results. | [optional] | -| **order** | [**QuerySortOrder**](QuerySortOrder.md) | | [optional][default to 'desc'] | +| Name | Type | Description | Notes | +| --------------- | ------------------------------------------------------------------------------- | ----------------------------------------- | ------------------------------------- | +| **aggregation** | [**FormulaAndFunctionEventAggregation**](FormulaAndFunctionEventAggregation.md) | | | +| **metric** | **String** | Metric used for sorting group by results. | [optional] | +| **order** | [**QuerySortOrder**](QuerySortOrder.md) | | [optional][default to 'desc'] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::FormulaAndFunctionEventQueryGroupBySort.new( order: null ) ``` - diff --git a/docs/v1/FormulaAndFunctionEventsDataSource.md b/docs/v1/FormulaAndFunctionEventsDataSource.md index 07c510456134..75050522d4f8 100644 --- a/docs/v1/FormulaAndFunctionEventsDataSource.md +++ b/docs/v1/FormulaAndFunctionEventsDataSource.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::FormulaAndFunctionEventsDataSource.new() ``` - diff --git a/docs/v1/FormulaAndFunctionMetricAggregation.md b/docs/v1/FormulaAndFunctionMetricAggregation.md index da6c0a704122..5cf8abc8bc3b 100644 --- a/docs/v1/FormulaAndFunctionMetricAggregation.md +++ b/docs/v1/FormulaAndFunctionMetricAggregation.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::FormulaAndFunctionMetricAggregation.new() ``` - diff --git a/docs/v1/FormulaAndFunctionMetricDataSource.md b/docs/v1/FormulaAndFunctionMetricDataSource.md index 4607b6764d54..c2212816eb79 100644 --- a/docs/v1/FormulaAndFunctionMetricDataSource.md +++ b/docs/v1/FormulaAndFunctionMetricDataSource.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::FormulaAndFunctionMetricDataSource.new() ``` - diff --git a/docs/v1/FormulaAndFunctionMetricQueryDefinition.md b/docs/v1/FormulaAndFunctionMetricQueryDefinition.md index 25d234e29316..188ada07f3c8 100644 --- a/docs/v1/FormulaAndFunctionMetricQueryDefinition.md +++ b/docs/v1/FormulaAndFunctionMetricQueryDefinition.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **aggregator** | [**FormulaAndFunctionMetricAggregation**](FormulaAndFunctionMetricAggregation.md) | | [optional] | -| **data_source** | [**FormulaAndFunctionMetricDataSource**](FormulaAndFunctionMetricDataSource.md) | | | -| **name** | **String** | Name of the query for use in formulas. | | -| **query** | **String** | Metrics query definition. | | +| Name | Type | Description | Notes | +| --------------- | --------------------------------------------------------------------------------- | -------------------------------------- | ---------- | +| **aggregator** | [**FormulaAndFunctionMetricAggregation**](FormulaAndFunctionMetricAggregation.md) | | [optional] | +| **data_source** | [**FormulaAndFunctionMetricDataSource**](FormulaAndFunctionMetricDataSource.md) | | | +| **name** | **String** | Name of the query for use in formulas. | | +| **query** | **String** | Metrics query definition. | | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V1::FormulaAndFunctionMetricQueryDefinition.new( query: avg:system.cpu.user{*} ) ``` - diff --git a/docs/v1/FormulaAndFunctionProcessQueryDataSource.md b/docs/v1/FormulaAndFunctionProcessQueryDataSource.md index 66c649c22e5c..205a4190d7d0 100644 --- a/docs/v1/FormulaAndFunctionProcessQueryDataSource.md +++ b/docs/v1/FormulaAndFunctionProcessQueryDataSource.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::FormulaAndFunctionProcessQueryDataSource.new() ``` - diff --git a/docs/v1/FormulaAndFunctionProcessQueryDefinition.md b/docs/v1/FormulaAndFunctionProcessQueryDefinition.md index 250145f8548c..2aa241407c44 100644 --- a/docs/v1/FormulaAndFunctionProcessQueryDefinition.md +++ b/docs/v1/FormulaAndFunctionProcessQueryDefinition.md @@ -2,17 +2,17 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **aggregator** | [**FormulaAndFunctionMetricAggregation**](FormulaAndFunctionMetricAggregation.md) | | [optional] | -| **data_source** | [**FormulaAndFunctionProcessQueryDataSource**](FormulaAndFunctionProcessQueryDataSource.md) | | | -| **is_normalized_cpu** | **Boolean** | Whether to normalize the CPU percentages. | [optional] | -| **limit** | **Integer** | Number of hits to return. | [optional] | -| **metric** | **String** | Process metric name. | | -| **name** | **String** | Name of query for use in formulas. | | -| **sort** | [**QuerySortOrder**](QuerySortOrder.md) | | [optional][default to 'desc'] | -| **tag_filters** | **Array<String>** | An array of tags to filter by. | [optional] | -| **text_filter** | **String** | Text to use as filter. | [optional] | +| Name | Type | Description | Notes | +| --------------------- | ------------------------------------------------------------------------------------------- | ----------------------------------------- | ------------------------------------- | +| **aggregator** | [**FormulaAndFunctionMetricAggregation**](FormulaAndFunctionMetricAggregation.md) | | [optional] | +| **data_source** | [**FormulaAndFunctionProcessQueryDataSource**](FormulaAndFunctionProcessQueryDataSource.md) | | | +| **is_normalized_cpu** | **Boolean** | Whether to normalize the CPU percentages. | [optional] | +| **limit** | **Integer** | Number of hits to return. | [optional] | +| **metric** | **String** | Process metric name. | | +| **name** | **String** | Name of query for use in formulas. | | +| **sort** | [**QuerySortOrder**](QuerySortOrder.md) | | [optional][default to 'desc'] | +| **tag_filters** | **Array<String>** | An array of tags to filter by. | [optional] | +| **text_filter** | **String** | Text to use as filter. | [optional] | ## Example @@ -31,4 +31,3 @@ instance = DatadogAPIClient::V1::FormulaAndFunctionProcessQueryDefinition.new( text_filter: null ) ``` - diff --git a/docs/v1/FormulaAndFunctionQueryDefinition.md b/docs/v1/FormulaAndFunctionQueryDefinition.md index 92314f5999c3..6bf2802db528 100644 --- a/docs/v1/FormulaAndFunctionQueryDefinition.md +++ b/docs/v1/FormulaAndFunctionQueryDefinition.md @@ -40,8 +40,8 @@ DatadogAPIClient::V1::FormulaAndFunctionQueryDefinition.build(data_that_doesnt_m #### Parameters -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| -------- | --------- | -------------------------------------------------- | | **data** | **Mixed** | data to be matched against the list of oneOf items | #### Return type @@ -52,4 +52,3 @@ DatadogAPIClient::V1::FormulaAndFunctionQueryDefinition.build(data_that_doesnt_m - `FormulaAndFunctionMetricQueryDefinition` - `FormulaAndFunctionProcessQueryDefinition` - `nil` (if no type matches) - diff --git a/docs/v1/FormulaAndFunctionResponseFormat.md b/docs/v1/FormulaAndFunctionResponseFormat.md index 90534a0e9c80..c97d6fdb93d6 100644 --- a/docs/v1/FormulaAndFunctionResponseFormat.md +++ b/docs/v1/FormulaAndFunctionResponseFormat.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::FormulaAndFunctionResponseFormat.new() ``` - diff --git a/docs/v1/FreeTextWidgetDefinition.md b/docs/v1/FreeTextWidgetDefinition.md index c84ab055f4a0..2790d24b9295 100644 --- a/docs/v1/FreeTextWidgetDefinition.md +++ b/docs/v1/FreeTextWidgetDefinition.md @@ -2,13 +2,13 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **color** | **String** | Color of the text. | [optional] | -| **font_size** | **String** | Size of the text. | [optional] | -| **text** | **String** | Text to display. | | -| **text_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | -| **type** | [**FreeTextWidgetDefinitionType**](FreeTextWidgetDefinitionType.md) | | [default to 'free_text'] | +| Name | Type | Description | Notes | +| -------------- | ------------------------------------------------------------------- | ------------------ | -------------------------------- | +| **color** | **String** | Color of the text. | [optional] | +| **font_size** | **String** | Size of the text. | [optional] | +| **text** | **String** | Text to display. | | +| **text_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | +| **type** | [**FreeTextWidgetDefinitionType**](FreeTextWidgetDefinitionType.md) | | [default to 'free_text'] | ## Example @@ -23,4 +23,3 @@ instance = DatadogAPIClient::V1::FreeTextWidgetDefinition.new( type: null ) ``` - diff --git a/docs/v1/FreeTextWidgetDefinitionType.md b/docs/v1/FreeTextWidgetDefinitionType.md index dec71b3b21cf..f4528378835c 100644 --- a/docs/v1/FreeTextWidgetDefinitionType.md +++ b/docs/v1/FreeTextWidgetDefinitionType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::FreeTextWidgetDefinitionType.new() ``` - diff --git a/docs/v1/FunnelQuery.md b/docs/v1/FunnelQuery.md index 2914303431c6..4526588c2006 100644 --- a/docs/v1/FunnelQuery.md +++ b/docs/v1/FunnelQuery.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data_source** | [**FunnelSource**](FunnelSource.md) | | [default to 'rum'] | -| **query_string** | **String** | The widget query. | | -| **steps** | **Array<Object>** | List of funnel steps. | | +| Name | Type | Description | Notes | +| ---------------- | ----------------------------------- | --------------------- | -------------------------- | +| **data_source** | [**FunnelSource**](FunnelSource.md) | | [default to 'rum'] | +| **query_string** | **String** | The widget query. | | +| **steps** | **Array<Object>** | List of funnel steps. | | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::FunnelQuery.new( steps: null ) ``` - diff --git a/docs/v1/FunnelRequestType.md b/docs/v1/FunnelRequestType.md index 7555063f4e6d..e7b85b281691 100644 --- a/docs/v1/FunnelRequestType.md +++ b/docs/v1/FunnelRequestType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::FunnelRequestType.new() ``` - diff --git a/docs/v1/FunnelSource.md b/docs/v1/FunnelSource.md index aa18d326b8f2..d62f2282b0b5 100644 --- a/docs/v1/FunnelSource.md +++ b/docs/v1/FunnelSource.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::FunnelSource.new() ``` - diff --git a/docs/v1/FunnelWidgetDefinition.md b/docs/v1/FunnelWidgetDefinition.md index 8f19a7ff58bc..47d327eadec0 100644 --- a/docs/v1/FunnelWidgetDefinition.md +++ b/docs/v1/FunnelWidgetDefinition.md @@ -2,14 +2,14 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **requests** | [**Array<FunnelWidgetRequest>**](FunnelWidgetRequest.md) | Request payload used to query items. | | -| **time** | [**WidgetTime**](WidgetTime.md) | | [optional] | -| **title** | **String** | The title of the widget. | [optional] | -| **title_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | -| **title_size** | **String** | The size of the title. | [optional] | -| **type** | [**FunnelWidgetDefinitionType**](FunnelWidgetDefinitionType.md) | | [default to 'funnel'] | +| Name | Type | Description | Notes | +| --------------- | --------------------------------------------------------------- | ------------------------------------ | ----------------------------- | +| **requests** | [**Array<FunnelWidgetRequest>**](FunnelWidgetRequest.md) | Request payload used to query items. | | +| **time** | [**WidgetTime**](WidgetTime.md) | | [optional] | +| **title** | **String** | The title of the widget. | [optional] | +| **title_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | +| **title_size** | **String** | The size of the title. | [optional] | +| **type** | [**FunnelWidgetDefinitionType**](FunnelWidgetDefinitionType.md) | | [default to 'funnel'] | ## Example @@ -25,4 +25,3 @@ instance = DatadogAPIClient::V1::FunnelWidgetDefinition.new( type: null ) ``` - diff --git a/docs/v1/FunnelWidgetDefinitionType.md b/docs/v1/FunnelWidgetDefinitionType.md index 83225eb472fb..c32abeaade79 100644 --- a/docs/v1/FunnelWidgetDefinitionType.md +++ b/docs/v1/FunnelWidgetDefinitionType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::FunnelWidgetDefinitionType.new() ``` - diff --git a/docs/v1/FunnelWidgetRequest.md b/docs/v1/FunnelWidgetRequest.md index a331481af2f7..4da5cdff54ac 100644 --- a/docs/v1/FunnelWidgetRequest.md +++ b/docs/v1/FunnelWidgetRequest.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **query** | [**FunnelQuery**](FunnelQuery.md) | | | -| **request_type** | [**FunnelRequestType**](FunnelRequestType.md) | | | +| Name | Type | Description | Notes | +| ---------------- | --------------------------------------------- | ----------- | ----- | +| **query** | [**FunnelQuery**](FunnelQuery.md) | | | +| **request_type** | [**FunnelRequestType**](FunnelRequestType.md) | | | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::FunnelWidgetRequest.new( request_type: null ) ``` - diff --git a/docs/v1/GCPAccount.md b/docs/v1/GCPAccount.md index 1585790a5dd5..f7a210868bc3 100644 --- a/docs/v1/GCPAccount.md +++ b/docs/v1/GCPAccount.md @@ -2,21 +2,21 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **auth_provider_x509_cert_url** | **String** | Should be `https://www.googleapis.com/oauth2/v1/certs`. | [optional] | -| **auth_uri** | **String** | Should be `https://accounts.google.com/o/oauth2/auth`. | [optional] | -| **automute** | **Boolean** | Silence monitors for expected GCE instance shutdowns. | [optional] | -| **client_email** | **String** | Your email found in your JSON service account key. | [optional] | -| **client_id** | **String** | Your ID found in your JSON service account key. | [optional] | -| **client_x509_cert_url** | **String** | Should be `https://www.googleapis.com/robot/v1/metadata/x509/<CLIENT_EMAIL>` where `<CLIENT_EMAIL>` is the email found in your JSON service account key. | [optional] | -| **errors** | **Array<String>** | An array of errors. | [optional] | -| **host_filters** | **String** | Limit the GCE instances that are pulled into Datadog by using tags. Only hosts that match one of the defined tags are imported into Datadog. | [optional] | -| **private_key** | **String** | Your private key name found in your JSON service account key. | [optional] | -| **private_key_id** | **String** | Your private key ID found in your JSON service account key. | [optional] | -| **project_id** | **String** | Your Google Cloud project ID found in your JSON service account key. | [optional] | -| **token_uri** | **String** | Should be `https://accounts.google.com/o/oauth2/token`. | [optional] | -| **type** | **String** | The value for service_account found in your JSON service account key. | [optional] | +| Name | Type | Description | Notes | +| ------------------------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **auth_provider_x509_cert_url** | **String** | Should be `https://www.googleapis.com/oauth2/v1/certs`. | [optional] | +| **auth_uri** | **String** | Should be `https://accounts.google.com/o/oauth2/auth`. | [optional] | +| **automute** | **Boolean** | Silence monitors for expected GCE instance shutdowns. | [optional] | +| **client_email** | **String** | Your email found in your JSON service account key. | [optional] | +| **client_id** | **String** | Your ID found in your JSON service account key. | [optional] | +| **client_x509_cert_url** | **String** | Should be `https://www.googleapis.com/robot/v1/metadata/x509/<CLIENT_EMAIL>` where `<CLIENT_EMAIL>` is the email found in your JSON service account key. | [optional] | +| **errors** | **Array<String>** | An array of errors. | [optional] | +| **host_filters** | **String** | Limit the GCE instances that are pulled into Datadog by using tags. Only hosts that match one of the defined tags are imported into Datadog. | [optional] | +| **private_key** | **String** | Your private key name found in your JSON service account key. | [optional] | +| **private_key_id** | **String** | Your private key ID found in your JSON service account key. | [optional] | +| **project_id** | **String** | Your Google Cloud project ID found in your JSON service account key. | [optional] | +| **token_uri** | **String** | Should be `https://accounts.google.com/o/oauth2/token`. | [optional] | +| **type** | **String** | The value for service_account found in your JSON service account key. | [optional] | ## Example @@ -39,4 +39,3 @@ instance = DatadogAPIClient::V1::GCPAccount.new( type: service_account ) ``` - diff --git a/docs/v1/GCPIntegrationAPI.md b/docs/v1/GCPIntegrationAPI.md index 53a7a398e7ef..702074e6fc78 100644 --- a/docs/v1/GCPIntegrationAPI.md +++ b/docs/v1/GCPIntegrationAPI.md @@ -2,13 +2,12 @@ All URIs are relative to *https://api.datadoghq.com* -| Method | HTTP request | Description | -| ------ | ------------ | ----------- | -| [**create_gcp_integration**](GCPIntegrationAPI.md#create_gcp_integration) | **POST** /api/v1/integration/gcp | Create a GCP integration | -| [**delete_gcp_integration**](GCPIntegrationAPI.md#delete_gcp_integration) | **DELETE** /api/v1/integration/gcp | Delete a GCP integration | -| [**list_gcp_integration**](GCPIntegrationAPI.md#list_gcp_integration) | **GET** /api/v1/integration/gcp | List all GCP integrations | -| [**update_gcp_integration**](GCPIntegrationAPI.md#update_gcp_integration) | **PUT** /api/v1/integration/gcp | Update a GCP integration | - +| Method | HTTP request | Description | +| ------------------------------------------------------------------------- | ---------------------------------- | ------------------------- | +| [**create_gcp_integration**](GCPIntegrationAPI.md#create_gcp_integration) | **POST** /api/v1/integration/gcp | Create a GCP integration | +| [**delete_gcp_integration**](GCPIntegrationAPI.md#delete_gcp_integration) | **DELETE** /api/v1/integration/gcp | Delete a GCP integration | +| [**list_gcp_integration**](GCPIntegrationAPI.md#list_gcp_integration) | **GET** /api/v1/integration/gcp | List all GCP integrations | +| [**update_gcp_integration**](GCPIntegrationAPI.md#update_gcp_integration) | **PUT** /api/v1/integration/gcp | Update a GCP integration | ## create_gcp_integration @@ -52,9 +51,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**GCPAccount**](GCPAccount.md) | Create a Datadog-GCP integration. | | +| Name | Type | Description | Notes | +| -------- | ------------------------------- | --------------------------------- | ----- | +| **body** | [**GCPAccount**](GCPAccount.md) | Create a Datadog-GCP integration. | | ### Return type @@ -69,7 +68,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## delete_gcp_integration > Object delete_gcp_integration(body) @@ -112,9 +110,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**GCPAccount**](GCPAccount.md) | Delete a given Datadog-GCP integration. | | +| Name | Type | Description | Notes | +| -------- | ------------------------------- | --------------------------------------- | ----- | +| **body** | [**GCPAccount**](GCPAccount.md) | Delete a given Datadog-GCP integration. | | ### Return type @@ -129,7 +127,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## list_gcp_integration > > list_gcp_integration @@ -186,7 +183,6 @@ This endpoint does not need any parameter. - **Content-Type**: Not defined - **Accept**: application/json - ## update_gcp_integration > Object update_gcp_integration(body) @@ -232,9 +228,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**GCPAccount**](GCPAccount.md) | Update a Datadog-GCP integration. | | +| Name | Type | Description | Notes | +| -------- | ------------------------------- | --------------------------------- | ----- | +| **body** | [**GCPAccount**](GCPAccount.md) | Update a Datadog-GCP integration. | | ### Return type @@ -248,4 +244,3 @@ end - **Content-Type**: application/json - **Accept**: application/json - diff --git a/docs/v1/GeomapWidgetDefinition.md b/docs/v1/GeomapWidgetDefinition.md index c5a05bc386c9..00cf5ede65f5 100644 --- a/docs/v1/GeomapWidgetDefinition.md +++ b/docs/v1/GeomapWidgetDefinition.md @@ -2,17 +2,17 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **custom_links** | [**Array<WidgetCustomLink>**](WidgetCustomLink.md) | A list of custom links. | [optional] | -| **requests** | [**Array<GeomapWidgetRequest>**](GeomapWidgetRequest.md) | Array of one request object to display in the widget. The request must contain a `group-by` tag whose value is a country ISO code. See the [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json) for information about building the `REQUEST_SCHEMA`. | | -| **style** | [**GeomapWidgetDefinitionStyle**](GeomapWidgetDefinitionStyle.md) | | | -| **time** | [**WidgetTime**](WidgetTime.md) | | [optional] | -| **title** | **String** | The title of your widget. | [optional] | -| **title_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | -| **title_size** | **String** | The size of the title. | [optional] | -| **type** | [**GeomapWidgetDefinitionType**](GeomapWidgetDefinitionType.md) | | [default to 'geomap'] | -| **view** | [**GeomapWidgetDefinitionView**](GeomapWidgetDefinitionView.md) | | | +| Name | Type | Description | Notes | +| ---------------- | ----------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- | +| **custom_links** | [**Array<WidgetCustomLink>**](WidgetCustomLink.md) | A list of custom links. | [optional] | +| **requests** | [**Array<GeomapWidgetRequest>**](GeomapWidgetRequest.md) | Array of one request object to display in the widget. The request must contain a `group-by` tag whose value is a country ISO code. See the [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json) for information about building the `REQUEST_SCHEMA`. | | +| **style** | [**GeomapWidgetDefinitionStyle**](GeomapWidgetDefinitionStyle.md) | | | +| **time** | [**WidgetTime**](WidgetTime.md) | | [optional] | +| **title** | **String** | The title of your widget. | [optional] | +| **title_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | +| **title_size** | **String** | The size of the title. | [optional] | +| **type** | [**GeomapWidgetDefinitionType**](GeomapWidgetDefinitionType.md) | | [default to 'geomap'] | +| **view** | [**GeomapWidgetDefinitionView**](GeomapWidgetDefinitionView.md) | | | ## Example @@ -31,4 +31,3 @@ instance = DatadogAPIClient::V1::GeomapWidgetDefinition.new( view: null ) ``` - diff --git a/docs/v1/GeomapWidgetDefinitionStyle.md b/docs/v1/GeomapWidgetDefinitionStyle.md index 3351481daa5a..0548b21f2703 100644 --- a/docs/v1/GeomapWidgetDefinitionStyle.md +++ b/docs/v1/GeomapWidgetDefinitionStyle.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **palette** | **String** | The color palette to apply to the widget. | | -| **palette_flip** | **Boolean** | Whether to flip the palette tones. | | +| Name | Type | Description | Notes | +| ---------------- | ----------- | ----------------------------------------- | ----- | +| **palette** | **String** | The color palette to apply to the widget. | | +| **palette_flip** | **Boolean** | Whether to flip the palette tones. | | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::GeomapWidgetDefinitionStyle.new( palette_flip: false ) ``` - diff --git a/docs/v1/GeomapWidgetDefinitionType.md b/docs/v1/GeomapWidgetDefinitionType.md index 89f761cc8207..c8aca3ffdec0 100644 --- a/docs/v1/GeomapWidgetDefinitionType.md +++ b/docs/v1/GeomapWidgetDefinitionType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::GeomapWidgetDefinitionType.new() ``` - diff --git a/docs/v1/GeomapWidgetDefinitionView.md b/docs/v1/GeomapWidgetDefinitionView.md index 69ea42a64827..2cc83861ca99 100644 --- a/docs/v1/GeomapWidgetDefinitionView.md +++ b/docs/v1/GeomapWidgetDefinitionView.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **focus** | **String** | The 2-letter ISO code of a country to focus the map on. Or `WORLD`. | | +| Name | Type | Description | Notes | +| --------- | ---------- | ----------------------------------------------------------------------------- | ----- | +| **focus** | **String** | The 2-letter ISO code of a country to focus the map on. Or `WORLD`. | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::GeomapWidgetDefinitionView.new( focus: WORLD ) ``` - diff --git a/docs/v1/GeomapWidgetRequest.md b/docs/v1/GeomapWidgetRequest.md index 901ebd4e68a8..cb26258f7bec 100644 --- a/docs/v1/GeomapWidgetRequest.md +++ b/docs/v1/GeomapWidgetRequest.md @@ -2,15 +2,15 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **formulas** | [**Array<WidgetFormula>**](WidgetFormula.md) | List of formulas that operate on queries. **This feature is currently in beta.** | [optional] | -| **log_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **q** | **String** | The widget metrics query. | [optional] | -| **queries** | [**Array<FormulaAndFunctionQueryDefinition>**](FormulaAndFunctionQueryDefinition.md) | List of queries that can be returned directly or used in formulas. **This feature is currently in beta.** | [optional] | -| **response_format** | [**FormulaAndFunctionResponseFormat**](FormulaAndFunctionResponseFormat.md) | | [optional] | -| **rum_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **security_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| Name | Type | Description | Notes | +| ------------------- | ------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------- | ---------- | +| **formulas** | [**Array<WidgetFormula>**](WidgetFormula.md) | List of formulas that operate on queries. **This feature is currently in beta.** | [optional] | +| **log_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **q** | **String** | The widget metrics query. | [optional] | +| **queries** | [**Array<FormulaAndFunctionQueryDefinition>**](FormulaAndFunctionQueryDefinition.md) | List of queries that can be returned directly or used in formulas. **This feature is currently in beta.** | [optional] | +| **response_format** | [**FormulaAndFunctionResponseFormat**](FormulaAndFunctionResponseFormat.md) | | [optional] | +| **rum_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **security_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | ## Example @@ -27,4 +27,3 @@ instance = DatadogAPIClient::V1::GeomapWidgetRequest.new( security_query: null ) ``` - diff --git a/docs/v1/GraphSnapshot.md b/docs/v1/GraphSnapshot.md index fab97ef40ecf..720c7d14e487 100644 --- a/docs/v1/GraphSnapshot.md +++ b/docs/v1/GraphSnapshot.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **graph_def** | **String** | A JSON document defining the graph. `graph_def` can be used instead of `metric_query`. The JSON document uses the [grammar defined here](https://docs.datadoghq.com/graphing/graphing_json/#grammar) and should be formatted to a single line then URL encoded. | [optional] | -| **metric_query** | **String** | The metric query. One of `metric_query` or `graph_def` is required. | [optional] | -| **snapshot_url** | **String** | URL of your [graph snapshot](https://docs.datadoghq.com/metrics/explorer/#snapshot). | [optional] | +| Name | Type | Description | Notes | +| ---------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **graph_def** | **String** | A JSON document defining the graph. `graph_def` can be used instead of `metric_query`. The JSON document uses the [grammar defined here](https://docs.datadoghq.com/graphing/graphing_json/#grammar) and should be formatted to a single line then URL encoded. | [optional] | +| **metric_query** | **String** | The metric query. One of `metric_query` or `graph_def` is required. | [optional] | +| **snapshot_url** | **String** | URL of your [graph snapshot](https://docs.datadoghq.com/metrics/explorer/#snapshot). | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::GraphSnapshot.new( snapshot_url: https://app.datadoghq.com/s/f12345678/aaa-bbb-ccc ) ``` - diff --git a/docs/v1/GroupWidgetDefinition.md b/docs/v1/GroupWidgetDefinition.md index 1a1ae53e9835..7bbb8e86798c 100644 --- a/docs/v1/GroupWidgetDefinition.md +++ b/docs/v1/GroupWidgetDefinition.md @@ -2,16 +2,16 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **background_color** | **String** | Background color of the group title. | [optional] | -| **banner_img** | **String** | URL of image to display as a banner for the group. | [optional] | -| **layout_type** | [**WidgetLayoutType**](WidgetLayoutType.md) | | | -| **show_title** | **Boolean** | Whether to show the title or not. | [optional][default to true] | -| **title** | **String** | Title of the widget. | [optional] | -| **title_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | -| **type** | [**GroupWidgetDefinitionType**](GroupWidgetDefinitionType.md) | | [default to 'group'] | -| **widgets** | [**Array<Widget>**](Widget.md) | List of widget groups. | | +| Name | Type | Description | Notes | +| -------------------- | ------------------------------------------------------------- | -------------------------------------------------- | ---------------------------- | +| **background_color** | **String** | Background color of the group title. | [optional] | +| **banner_img** | **String** | URL of image to display as a banner for the group. | [optional] | +| **layout_type** | [**WidgetLayoutType**](WidgetLayoutType.md) | | | +| **show_title** | **Boolean** | Whether to show the title or not. | [optional][default to true] | +| **title** | **String** | Title of the widget. | [optional] | +| **title_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | +| **type** | [**GroupWidgetDefinitionType**](GroupWidgetDefinitionType.md) | | [default to 'group'] | +| **widgets** | [**Array<Widget>**](Widget.md) | List of widget groups. | | ## Example @@ -29,4 +29,3 @@ instance = DatadogAPIClient::V1::GroupWidgetDefinition.new( widgets: [{"definition":{"requests":{"fill":{"q":"system.cpu.user"}},"type":"hostmap"}}] ) ``` - diff --git a/docs/v1/GroupWidgetDefinitionType.md b/docs/v1/GroupWidgetDefinitionType.md index 2036ba6805c4..aaca4cd7f20c 100644 --- a/docs/v1/GroupWidgetDefinitionType.md +++ b/docs/v1/GroupWidgetDefinitionType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::GroupWidgetDefinitionType.new() ``` - diff --git a/docs/v1/HTTPLogError.md b/docs/v1/HTTPLogError.md index cccfc5a96326..675db3f1aadd 100644 --- a/docs/v1/HTTPLogError.md +++ b/docs/v1/HTTPLogError.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **code** | **Integer** | Error code. | | -| **message** | **String** | Error message. | | +| Name | Type | Description | Notes | +| ----------- | ----------- | -------------- | ----- | +| **code** | **Integer** | Error code. | | +| **message** | **String** | Error message. | | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::HTTPLogError.new( message: Your browser sent an invalid request. ) ``` - diff --git a/docs/v1/HTTPLogItem.md b/docs/v1/HTTPLogItem.md index 14ef8835c781..26fb0b4ed2ed 100644 --- a/docs/v1/HTTPLogItem.md +++ b/docs/v1/HTTPLogItem.md @@ -2,13 +2,13 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **ddsource** | **String** | The integration name associated with your log: the technology from which the log originated. When it matches an integration name, Datadog automatically installs the corresponding parsers and facets. See [reserved attributes](https://docs.datadoghq.com/logs/log_collection/#reserved-attributes). | [optional] | -| **ddtags** | **String** | Tags associated with your logs. | [optional] | -| **hostname** | **String** | The name of the originating host of the log. | [optional] | -| **message** | **String** | The message [reserved attribute](https://docs.datadoghq.com/logs/log_collection/#reserved-attributes) of your log. By default, Datadog ingests the value of the message attribute as the body of the log entry. That value is then highlighted and displayed in the Logstream, where it is indexed for full text search. | [optional] | -| **service** | **String** | The name of the application or service generating the log events. It is used to switch from Logs to APM, so make sure you define the same value when you use both products. See [reserved attributes](https://docs.datadoghq.com/logs/log_collection/#reserved-attributes). | [optional] | +| Name | Type | Description | Notes | +| ------------ | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------- | +| **ddsource** | **String** | The integration name associated with your log: the technology from which the log originated. When it matches an integration name, Datadog automatically installs the corresponding parsers and facets. See [reserved attributes](https://docs.datadoghq.com/logs/log_collection/#reserved-attributes). | [optional] | +| **ddtags** | **String** | Tags associated with your logs. | [optional] | +| **hostname** | **String** | The name of the originating host of the log. | [optional] | +| **message** | **String** | The message [reserved attribute](https://docs.datadoghq.com/logs/log_collection/#reserved-attributes) of your log. By default, Datadog ingests the value of the message attribute as the body of the log entry. That value is then highlighted and displayed in the Logstream, where it is indexed for full text search. | [optional] | +| **service** | **String** | The name of the application or service generating the log events. It is used to switch from Logs to APM, so make sure you define the same value when you use both products. See [reserved attributes](https://docs.datadoghq.com/logs/log_collection/#reserved-attributes). | [optional] | ## Example @@ -23,4 +23,3 @@ instance = DatadogAPIClient::V1::HTTPLogItem.new( service: payment ) ``` - diff --git a/docs/v1/HTTPMethod.md b/docs/v1/HTTPMethod.md index 3b91ba42cac7..6b5fe4b43902 100644 --- a/docs/v1/HTTPMethod.md +++ b/docs/v1/HTTPMethod.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::HTTPMethod.new() ``` - diff --git a/docs/v1/HeatMapWidgetDefinition.md b/docs/v1/HeatMapWidgetDefinition.md index 43f3f941025b..f9254b2ea8c7 100644 --- a/docs/v1/HeatMapWidgetDefinition.md +++ b/docs/v1/HeatMapWidgetDefinition.md @@ -2,19 +2,19 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **custom_links** | [**Array<WidgetCustomLink>**](WidgetCustomLink.md) | List of custom links. | [optional] | -| **events** | [**Array<WidgetEvent>**](WidgetEvent.md) | List of widget events. | [optional] | -| **legend_size** | **String** | Available legend sizes for a widget. Should be one of \"0\", \"2\", \"4\", \"8\", \"16\", or \"auto\". | [optional] | -| **requests** | [**Array<HeatMapWidgetRequest>**](HeatMapWidgetRequest.md) | List of widget types. | | -| **show_legend** | **Boolean** | Whether or not to display the legend on this widget. | [optional] | -| **time** | [**WidgetTime**](WidgetTime.md) | | [optional] | -| **title** | **String** | Title of the widget. | [optional] | -| **title_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | -| **title_size** | **String** | Size of the title. | [optional] | -| **type** | [**HeatMapWidgetDefinitionType**](HeatMapWidgetDefinitionType.md) | | [default to 'heatmap'] | -| **yaxis** | [**WidgetAxis**](WidgetAxis.md) | | [optional] | +| Name | Type | Description | Notes | +| ---------------- | ----------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------ | +| **custom_links** | [**Array<WidgetCustomLink>**](WidgetCustomLink.md) | List of custom links. | [optional] | +| **events** | [**Array<WidgetEvent>**](WidgetEvent.md) | List of widget events. | [optional] | +| **legend_size** | **String** | Available legend sizes for a widget. Should be one of \"0\", \"2\", \"4\", \"8\", \"16\", or \"auto\". | [optional] | +| **requests** | [**Array<HeatMapWidgetRequest>**](HeatMapWidgetRequest.md) | List of widget types. | | +| **show_legend** | **Boolean** | Whether or not to display the legend on this widget. | [optional] | +| **time** | [**WidgetTime**](WidgetTime.md) | | [optional] | +| **title** | **String** | Title of the widget. | [optional] | +| **title_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | +| **title_size** | **String** | Size of the title. | [optional] | +| **type** | [**HeatMapWidgetDefinitionType**](HeatMapWidgetDefinitionType.md) | | [default to 'heatmap'] | +| **yaxis** | [**WidgetAxis**](WidgetAxis.md) | | [optional] | ## Example @@ -35,4 +35,3 @@ instance = DatadogAPIClient::V1::HeatMapWidgetDefinition.new( yaxis: null ) ``` - diff --git a/docs/v1/HeatMapWidgetDefinitionType.md b/docs/v1/HeatMapWidgetDefinitionType.md index 0a079e7afa7d..524c46993fb1 100644 --- a/docs/v1/HeatMapWidgetDefinitionType.md +++ b/docs/v1/HeatMapWidgetDefinitionType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::HeatMapWidgetDefinitionType.new() ``` - diff --git a/docs/v1/HeatMapWidgetRequest.md b/docs/v1/HeatMapWidgetRequest.md index 7a84009feb47..439b3d228fd7 100644 --- a/docs/v1/HeatMapWidgetRequest.md +++ b/docs/v1/HeatMapWidgetRequest.md @@ -2,18 +2,18 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **apm_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **event_query** | [**EventQueryDefinition**](EventQueryDefinition.md) | | [optional] | -| **log_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **network_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **process_query** | [**ProcessQueryDefinition**](ProcessQueryDefinition.md) | | [optional] | -| **profile_metrics_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **q** | **String** | Widget query. | [optional] | -| **rum_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **security_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **style** | [**WidgetStyle**](WidgetStyle.md) | | [optional] | +| Name | Type | Description | Notes | +| ------------------------- | ------------------------------------------------------- | ------------- | ---------- | +| **apm_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **event_query** | [**EventQueryDefinition**](EventQueryDefinition.md) | | [optional] | +| **log_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **network_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **process_query** | [**ProcessQueryDefinition**](ProcessQueryDefinition.md) | | [optional] | +| **profile_metrics_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **q** | **String** | Widget query. | [optional] | +| **rum_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **security_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **style** | [**WidgetStyle**](WidgetStyle.md) | | [optional] | ## Example @@ -33,4 +33,3 @@ instance = DatadogAPIClient::V1::HeatMapWidgetRequest.new( style: null ) ``` - diff --git a/docs/v1/Host.md b/docs/v1/Host.md index cbe46e6093c1..79bbc2d56502 100644 --- a/docs/v1/Host.md +++ b/docs/v1/Host.md @@ -2,22 +2,22 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **aliases** | **Array<String>** | Host aliases collected by Datadog. | [optional] | -| **apps** | **Array<String>** | The Datadog integrations reporting metrics for the host. | [optional] | -| **aws_name** | **String** | AWS name of your host. | [optional] | -| **host_name** | **String** | The host name. | [optional] | -| **id** | **Integer** | The host ID. | [optional] | -| **is_muted** | **Boolean** | If a host is muted or unmuted. | [optional] | -| **last_reported_time** | **Integer** | Last time the host reported a metric data point. | [optional] | -| **meta** | [**HostMeta**](HostMeta.md) | | [optional] | -| **metrics** | [**HostMetrics**](HostMetrics.md) | | [optional] | -| **mute_timeout** | **Integer** | Timeout of the mute applied to your host. | [optional] | -| **name** | **String** | The host name. | [optional] | -| **sources** | **Array<String>** | Source or cloud provider associated with your host. | [optional] | -| **tags_by_source** | **Hash<String, Array<String>>** | List of tags for each source (AWS, Datadog Agent, Chef..). | [optional] | -| **up** | **Boolean** | Displays UP when the expected metrics are received and displays `???` if no metrics are received. | [optional] | +| Name | Type | Description | Notes | +| ---------------------- | ------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ---------- | +| **aliases** | **Array<String>** | Host aliases collected by Datadog. | [optional] | +| **apps** | **Array<String>** | The Datadog integrations reporting metrics for the host. | [optional] | +| **aws_name** | **String** | AWS name of your host. | [optional] | +| **host_name** | **String** | The host name. | [optional] | +| **id** | **Integer** | The host ID. | [optional] | +| **is_muted** | **Boolean** | If a host is muted or unmuted. | [optional] | +| **last_reported_time** | **Integer** | Last time the host reported a metric data point. | [optional] | +| **meta** | [**HostMeta**](HostMeta.md) | | [optional] | +| **metrics** | [**HostMetrics**](HostMetrics.md) | | [optional] | +| **mute_timeout** | **Integer** | Timeout of the mute applied to your host. | [optional] | +| **name** | **String** | The host name. | [optional] | +| **sources** | **Array<String>** | Source or cloud provider associated with your host. | [optional] | +| **tags_by_source** | **Hash<String, Array<String>>** | List of tags for each source (AWS, Datadog Agent, Chef..). | [optional] | +| **up** | **Boolean** | Displays UP when the expected metrics are received and displays `???` if no metrics are received. | [optional] | ## Example @@ -41,4 +41,3 @@ instance = DatadogAPIClient::V1::Host.new( up: true ) ``` - diff --git a/docs/v1/HostListResponse.md b/docs/v1/HostListResponse.md index 979adc7405ca..5ab403bbc9b0 100644 --- a/docs/v1/HostListResponse.md +++ b/docs/v1/HostListResponse.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **host_list** | [**Array<Host>**](Host.md) | Array of hosts. | [optional] | -| **total_matching** | **Integer** | Number of host matching the query. | [optional] | -| **total_returned** | **Integer** | Number of host returned. | [optional] | +| Name | Type | Description | Notes | +| ------------------ | -------------------------------- | ---------------------------------- | ---------- | +| **host_list** | [**Array<Host>**](Host.md) | Array of hosts. | [optional] | +| **total_matching** | **Integer** | Number of host matching the query. | [optional] | +| **total_returned** | **Integer** | Number of host returned. | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::HostListResponse.new( total_returned: 1 ) ``` - diff --git a/docs/v1/HostMapRequest.md b/docs/v1/HostMapRequest.md index 6f0cc339002d..38f1bd9fe289 100644 --- a/docs/v1/HostMapRequest.md +++ b/docs/v1/HostMapRequest.md @@ -2,17 +2,17 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **apm_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **event_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **log_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **network_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **process_query** | [**ProcessQueryDefinition**](ProcessQueryDefinition.md) | | [optional] | -| **profile_metrics_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **q** | **String** | Query definition. | [optional] | -| **rum_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **security_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| Name | Type | Description | Notes | +| ------------------------- | ------------------------------------------------------- | ----------------- | ---------- | +| **apm_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **event_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **log_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **network_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **process_query** | [**ProcessQueryDefinition**](ProcessQueryDefinition.md) | | [optional] | +| **profile_metrics_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **q** | **String** | Query definition. | [optional] | +| **rum_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **security_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | ## Example @@ -31,4 +31,3 @@ instance = DatadogAPIClient::V1::HostMapRequest.new( security_query: null ) ``` - diff --git a/docs/v1/HostMapWidgetDefinition.md b/docs/v1/HostMapWidgetDefinition.md index 83fbb03d03ca..db70f502a842 100644 --- a/docs/v1/HostMapWidgetDefinition.md +++ b/docs/v1/HostMapWidgetDefinition.md @@ -2,21 +2,21 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **custom_links** | [**Array<WidgetCustomLink>**](WidgetCustomLink.md) | List of custom links. | [optional] | -| **group** | **Array<String>** | List of tag prefixes to group by. | [optional] | -| **no_group_hosts** | **Boolean** | Whether to show the hosts that don’t fit in a group. | [optional] | -| **no_metric_hosts** | **Boolean** | Whether to show the hosts with no metrics. | [optional] | -| **node_type** | [**WidgetNodeType**](WidgetNodeType.md) | | [optional] | -| **notes** | **String** | Notes on the title. | [optional] | -| **requests** | [**HostMapWidgetDefinitionRequests**](HostMapWidgetDefinitionRequests.md) | | | -| **scope** | **Array<String>** | List of tags used to filter the map. | [optional] | -| **style** | [**HostMapWidgetDefinitionStyle**](HostMapWidgetDefinitionStyle.md) | | [optional] | -| **title** | **String** | Title of the widget. | [optional] | -| **title_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | -| **title_size** | **String** | Size of the title. | [optional] | -| **type** | [**HostMapWidgetDefinitionType**](HostMapWidgetDefinitionType.md) | | [default to 'hostmap'] | +| Name | Type | Description | Notes | +| ------------------- | ------------------------------------------------------------------------- | ---------------------------------------------------- | ------------------------------ | +| **custom_links** | [**Array<WidgetCustomLink>**](WidgetCustomLink.md) | List of custom links. | [optional] | +| **group** | **Array<String>** | List of tag prefixes to group by. | [optional] | +| **no_group_hosts** | **Boolean** | Whether to show the hosts that don’t fit in a group. | [optional] | +| **no_metric_hosts** | **Boolean** | Whether to show the hosts with no metrics. | [optional] | +| **node_type** | [**WidgetNodeType**](WidgetNodeType.md) | | [optional] | +| **notes** | **String** | Notes on the title. | [optional] | +| **requests** | [**HostMapWidgetDefinitionRequests**](HostMapWidgetDefinitionRequests.md) | | | +| **scope** | **Array<String>** | List of tags used to filter the map. | [optional] | +| **style** | [**HostMapWidgetDefinitionStyle**](HostMapWidgetDefinitionStyle.md) | | [optional] | +| **title** | **String** | Title of the widget. | [optional] | +| **title_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | +| **title_size** | **String** | Size of the title. | [optional] | +| **type** | [**HostMapWidgetDefinitionType**](HostMapWidgetDefinitionType.md) | | [default to 'hostmap'] | ## Example @@ -39,4 +39,3 @@ instance = DatadogAPIClient::V1::HostMapWidgetDefinition.new( type: null ) ``` - diff --git a/docs/v1/HostMapWidgetDefinitionRequests.md b/docs/v1/HostMapWidgetDefinitionRequests.md index e2f98b670ed6..345f31728b32 100644 --- a/docs/v1/HostMapWidgetDefinitionRequests.md +++ b/docs/v1/HostMapWidgetDefinitionRequests.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **fill** | [**HostMapRequest**](HostMapRequest.md) | | [optional] | -| **size** | [**HostMapRequest**](HostMapRequest.md) | | [optional] | +| Name | Type | Description | Notes | +| -------- | --------------------------------------- | ----------- | ---------- | +| **fill** | [**HostMapRequest**](HostMapRequest.md) | | [optional] | +| **size** | [**HostMapRequest**](HostMapRequest.md) | | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::HostMapWidgetDefinitionRequests.new( size: null ) ``` - diff --git a/docs/v1/HostMapWidgetDefinitionStyle.md b/docs/v1/HostMapWidgetDefinitionStyle.md index 5924e28f5e59..5b846ba771d0 100644 --- a/docs/v1/HostMapWidgetDefinitionStyle.md +++ b/docs/v1/HostMapWidgetDefinitionStyle.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **fill_max** | **String** | Max value to use to color the map. | [optional] | -| **fill_min** | **String** | Min value to use to color the map. | [optional] | -| **palette** | **String** | Color palette to apply to the widget. | [optional] | -| **palette_flip** | **Boolean** | Whether to flip the palette tones. | [optional] | +| Name | Type | Description | Notes | +| ---------------- | ----------- | ------------------------------------- | ---------- | +| **fill_max** | **String** | Max value to use to color the map. | [optional] | +| **fill_min** | **String** | Min value to use to color the map. | [optional] | +| **palette** | **String** | Color palette to apply to the widget. | [optional] | +| **palette_flip** | **Boolean** | Whether to flip the palette tones. | [optional] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V1::HostMapWidgetDefinitionStyle.new( palette_flip: null ) ``` - diff --git a/docs/v1/HostMapWidgetDefinitionType.md b/docs/v1/HostMapWidgetDefinitionType.md index f67a127a5af1..f2e6d6d53f6f 100644 --- a/docs/v1/HostMapWidgetDefinitionType.md +++ b/docs/v1/HostMapWidgetDefinitionType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::HostMapWidgetDefinitionType.new() ``` - diff --git a/docs/v1/HostMeta.md b/docs/v1/HostMeta.md index 63b6e7115df9..8acef805f2ef 100644 --- a/docs/v1/HostMeta.md +++ b/docs/v1/HostMeta.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| --------- | ----------------------- | ----------------------- | ---------- | | **nix_v** | **Array<String>** | Array of Unix versions. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::HostMeta.new( nix_v: null ) ``` - diff --git a/docs/v1/HostMetrics.md b/docs/v1/HostMetrics.md index 882bc82cf4aa..05d8d7cc87d9 100644 --- a/docs/v1/HostMetrics.md +++ b/docs/v1/HostMetrics.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **cpu** | **Float** | The percent of CPU used (everything but idle). | [optional] | +| Name | Type | Description | Notes | +| ---------- | --------- | ---------------------------------------------------------------------------- | ---------- | +| **cpu** | **Float** | The percent of CPU used (everything but idle). | [optional] | | **iowait** | **Float** | The percent of CPU spent waiting on the IO (not reported for all platforms). | [optional] | -| **load** | **Float** | The system load over the last 15 minutes. | [optional] | +| **load** | **Float** | The system load over the last 15 minutes. | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::HostMetrics.new( load: 0.5 ) ``` - diff --git a/docs/v1/HostMuteResponse.md b/docs/v1/HostMuteResponse.md index cdd8e7a9b66c..192bba3626e4 100644 --- a/docs/v1/HostMuteResponse.md +++ b/docs/v1/HostMuteResponse.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **action** | **String** | Action applied to the hosts. | [optional] | -| **_end** | **Integer** | POSIX timestamp in seconds when the host is unmuted. | [optional] | -| **hostname** | **String** | The host name. | [optional] | -| **message** | **String** | Message associated with the mute. | [optional] | +| Name | Type | Description | Notes | +| ------------ | ----------- | ---------------------------------------------------- | ---------- | +| **action** | **String** | Action applied to the hosts. | [optional] | +| **\_end** | **Integer** | POSIX timestamp in seconds when the host is unmuted. | [optional] | +| **hostname** | **String** | The host name. | [optional] | +| **message** | **String** | Message associated with the mute. | [optional] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V1::HostMuteResponse.new( message: Muting this host for a test! ) ``` - diff --git a/docs/v1/HostMuteSettings.md b/docs/v1/HostMuteSettings.md index 89346598feb8..db6b8f70d4b1 100644 --- a/docs/v1/HostMuteSettings.md +++ b/docs/v1/HostMuteSettings.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **_end** | **Integer** | POSIX timestamp in seconds when the host is unmuted. If omitted, the host remains muted until explicitly unmuted. | [optional] | -| **message** | **String** | Message to associate with the muting of this host. | [optional] | -| **override** | **Boolean** | If true and the host is already muted, replaces existing host mute settings. | [optional] | +| Name | Type | Description | Notes | +| ------------ | ----------- | ----------------------------------------------------------------------------------------------------------------- | ---------- | +| **\_end** | **Integer** | POSIX timestamp in seconds when the host is unmuted. If omitted, the host remains muted until explicitly unmuted. | [optional] | +| **message** | **String** | Message to associate with the muting of this host. | [optional] | +| **override** | **Boolean** | If true and the host is already muted, replaces existing host mute settings. | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::HostMuteSettings.new( override: false ) ``` - diff --git a/docs/v1/HostTags.md b/docs/v1/HostTags.md index f795a081574f..ae6348e76e74 100644 --- a/docs/v1/HostTags.md +++ b/docs/v1/HostTags.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **host** | **String** | Your host name. | [optional] | +| Name | Type | Description | Notes | +| -------- | ----------------------- | ------------------------------------ | ---------- | +| **host** | **String** | Your host name. | [optional] | | **tags** | **Array<String>** | A list of tags to apply to the host. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::HostTags.new( tags: null ) ``` - diff --git a/docs/v1/HostTotals.md b/docs/v1/HostTotals.md index 40bb4e3e98b5..7ce64d3210e3 100644 --- a/docs/v1/HostTotals.md +++ b/docs/v1/HostTotals.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| ---------------- | ----------- | -------------------------------------------------------------- | ---------- | | **total_active** | **Integer** | Total number of active host (UP and ???) reporting to Datadog. | [optional] | -| **total_up** | **Integer** | Number of host that are UP and reporting to Datadog. | [optional] | +| **total_up** | **Integer** | Number of host that are UP and reporting to Datadog. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::HostTotals.new( total_up: null ) ``` - diff --git a/docs/v1/HostsAPI.md b/docs/v1/HostsAPI.md index 7cdbe5e6f986..41a636a60220 100644 --- a/docs/v1/HostsAPI.md +++ b/docs/v1/HostsAPI.md @@ -2,13 +2,12 @@ All URIs are relative to *https://api.datadoghq.com* -| Method | HTTP request | Description | -| ------ | ------------ | ----------- | -| [**get_host_totals**](HostsAPI.md#get_host_totals) | **GET** /api/v1/hosts/totals | Get the total number of active hosts | -| [**list_hosts**](HostsAPI.md#list_hosts) | **GET** /api/v1/hosts | Get all hosts for your organization | -| [**mute_host**](HostsAPI.md#mute_host) | **POST** /api/v1/host/{host_name}/mute | Mute a host | -| [**unmute_host**](HostsAPI.md#unmute_host) | **POST** /api/v1/host/{host_name}/unmute | Unmute a host | - +| Method | HTTP request | Description | +| -------------------------------------------------- | ---------------------------------------- | ------------------------------------ | +| [**get_host_totals**](HostsAPI.md#get_host_totals) | **GET** /api/v1/hosts/totals | Get the total number of active hosts | +| [**list_hosts**](HostsAPI.md#list_hosts) | **GET** /api/v1/hosts | Get all hosts for your organization | +| [**mute_host**](HostsAPI.md#mute_host) | **POST** /api/v1/host/{host_name}/mute | Mute a host | +| [**unmute_host**](HostsAPI.md#unmute_host) | **POST** /api/v1/host/{host_name}/unmute | Unmute a host | ## get_host_totals @@ -55,8 +54,8 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| -------- | ----------- | -------------------------------------------------------------------------- | ---------- | | **from** | **Integer** | Number of seconds from which you want to get total number of active hosts. | [optional] | ### Return type @@ -72,7 +71,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## list_hosts > list_hosts(opts) @@ -127,16 +125,16 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **filter** | **String** | String to filter search results. | [optional] | -| **sort_field** | **String** | Sort hosts by this field. | [optional] | -| **sort_dir** | **String** | Direction of sort. Options include `asc` and `desc`. | [optional] | -| **start** | **Integer** | Host result to start search from. | [optional] | -| **count** | **Integer** | Number of hosts to return. Max 1000. | [optional] | -| **from** | **Integer** | Number of seconds since UNIX epoch from which you want to search your hosts. | [optional] | -| **include_muted_hosts_data** | **Boolean** | Include information on the muted status of hosts and when the mute expires. | [optional] | -| **include_hosts_metadata** | **Boolean** | Include additional metadata about the hosts (agent_version, machine, platform, processor, etc.). | [optional] | +| Name | Type | Description | Notes | +| ---------------------------- | ----------- | ------------------------------------------------------------------------------------------------ | ---------- | +| **filter** | **String** | String to filter search results. | [optional] | +| **sort_field** | **String** | Sort hosts by this field. | [optional] | +| **sort_dir** | **String** | Direction of sort. Options include `asc` and `desc`. | [optional] | +| **start** | **Integer** | Host result to start search from. | [optional] | +| **count** | **Integer** | Number of hosts to return. Max 1000. | [optional] | +| **from** | **Integer** | Number of seconds since UNIX epoch from which you want to search your hosts. | [optional] | +| **include_muted_hosts_data** | **Boolean** | Include information on the muted status of hosts and when the mute expires. | [optional] | +| **include_hosts_metadata** | **Boolean** | Include additional metadata about the hosts (agent_version, machine, platform, processor, etc.). | [optional] | ### Return type @@ -151,7 +149,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## mute_host > mute_host(host_name, body) @@ -195,10 +192,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **host_name** | **String** | Name of the host to mute. | | -| **body** | [**HostMuteSettings**](HostMuteSettings.md) | Mute a host request body. | | +| Name | Type | Description | Notes | +| ------------- | ------------------------------------------- | ------------------------- | ----- | +| **host_name** | **String** | Name of the host to mute. | | +| **body** | [**HostMuteSettings**](HostMuteSettings.md) | Mute a host request body. | | ### Return type @@ -213,7 +210,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## unmute_host > unmute_host(host_name) @@ -256,9 +252,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **host_name** | **String** | Name of the host to unmute. | | +| Name | Type | Description | Notes | +| ------------- | ---------- | --------------------------- | ----- | +| **host_name** | **String** | Name of the host to unmute. | | ### Return type @@ -272,4 +268,3 @@ end - **Content-Type**: Not defined - **Accept**: application/json - diff --git a/docs/v1/IFrameWidgetDefinition.md b/docs/v1/IFrameWidgetDefinition.md index 07930b87ea7d..205aee61c273 100644 --- a/docs/v1/IFrameWidgetDefinition.md +++ b/docs/v1/IFrameWidgetDefinition.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **type** | [**IFrameWidgetDefinitionType**](IFrameWidgetDefinitionType.md) | | [default to 'iframe'] | -| **url** | **String** | URL of the iframe. | | +| Name | Type | Description | Notes | +| -------- | --------------------------------------------------------------- | ------------------ | ----------------------------- | +| **type** | [**IFrameWidgetDefinitionType**](IFrameWidgetDefinitionType.md) | | [default to 'iframe'] | +| **url** | **String** | URL of the iframe. | | ## Example @@ -14,7 +14,6 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::IFrameWidgetDefinition.new( type: null, - url: + url: ) ``` - diff --git a/docs/v1/IFrameWidgetDefinitionType.md b/docs/v1/IFrameWidgetDefinitionType.md index fd182d352866..d43caece9679 100644 --- a/docs/v1/IFrameWidgetDefinitionType.md +++ b/docs/v1/IFrameWidgetDefinitionType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::IFrameWidgetDefinitionType.new() ``` - diff --git a/docs/v1/IPPrefixesAPI.md b/docs/v1/IPPrefixesAPI.md index 38f69e7f8537..7b1fe90a9643 100644 --- a/docs/v1/IPPrefixesAPI.md +++ b/docs/v1/IPPrefixesAPI.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| ----------------- | ----------------------- | ---------------------- | ---------- | | **prefixes_ipv4** | **Array<String>** | List of IPv4 prefixes. | [optional] | | **prefixes_ipv6** | **Array<String>** | List of IPv6 prefixes. | [optional] | @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::IPPrefixesAPI.new( prefixes_ipv6: null ) ``` - diff --git a/docs/v1/IPPrefixesAPM.md b/docs/v1/IPPrefixesAPM.md index 464aaba55a5c..b603db92ee9f 100644 --- a/docs/v1/IPPrefixesAPM.md +++ b/docs/v1/IPPrefixesAPM.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| ----------------- | ----------------------- | ---------------------- | ---------- | | **prefixes_ipv4** | **Array<String>** | List of IPv4 prefixes. | [optional] | | **prefixes_ipv6** | **Array<String>** | List of IPv6 prefixes. | [optional] | @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::IPPrefixesAPM.new( prefixes_ipv6: null ) ``` - diff --git a/docs/v1/IPPrefixesAgents.md b/docs/v1/IPPrefixesAgents.md index 37087e36036f..6b2ac0384250 100644 --- a/docs/v1/IPPrefixesAgents.md +++ b/docs/v1/IPPrefixesAgents.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| ----------------- | ----------------------- | ---------------------- | ---------- | | **prefixes_ipv4** | **Array<String>** | List of IPv4 prefixes. | [optional] | | **prefixes_ipv6** | **Array<String>** | List of IPv6 prefixes. | [optional] | @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::IPPrefixesAgents.new( prefixes_ipv6: null ) ``` - diff --git a/docs/v1/IPPrefixesLogs.md b/docs/v1/IPPrefixesLogs.md index 86e55d453857..af59ff8d3292 100644 --- a/docs/v1/IPPrefixesLogs.md +++ b/docs/v1/IPPrefixesLogs.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| ----------------- | ----------------------- | ---------------------- | ---------- | | **prefixes_ipv4** | **Array<String>** | List of IPv4 prefixes. | [optional] | | **prefixes_ipv6** | **Array<String>** | List of IPv6 prefixes. | [optional] | @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::IPPrefixesLogs.new( prefixes_ipv6: null ) ``` - diff --git a/docs/v1/IPPrefixesProcess.md b/docs/v1/IPPrefixesProcess.md index afd87284d52a..a39a9ce6e776 100644 --- a/docs/v1/IPPrefixesProcess.md +++ b/docs/v1/IPPrefixesProcess.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| ----------------- | ----------------------- | ---------------------- | ---------- | | **prefixes_ipv4** | **Array<String>** | List of IPv4 prefixes. | [optional] | | **prefixes_ipv6** | **Array<String>** | List of IPv6 prefixes. | [optional] | @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::IPPrefixesProcess.new( prefixes_ipv6: null ) ``` - diff --git a/docs/v1/IPPrefixesSynthetics.md b/docs/v1/IPPrefixesSynthetics.md index 24ed1783e09a..3ab30a483a39 100644 --- a/docs/v1/IPPrefixesSynthetics.md +++ b/docs/v1/IPPrefixesSynthetics.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **prefixes_ipv4** | **Array<String>** | List of IPv4 prefixes. | [optional] | +| Name | Type | Description | Notes | +| ----------------------------- | ------------------------------------------- | ---------------------------------- | ---------- | +| **prefixes_ipv4** | **Array<String>** | List of IPv4 prefixes. | [optional] | | **prefixes_ipv4_by_location** | **Hash<String, Array<String>>** | List of IPv4 prefixes by location. | [optional] | -| **prefixes_ipv6** | **Array<String>** | List of IPv6 prefixes. | [optional] | +| **prefixes_ipv6** | **Array<String>** | List of IPv6 prefixes. | [optional] | | **prefixes_ipv6_by_location** | **Hash<String, Array<String>>** | List of IPv6 prefixes by location. | [optional] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V1::IPPrefixesSynthetics.new( prefixes_ipv6_by_location: null ) ``` - diff --git a/docs/v1/IPPrefixesWebhooks.md b/docs/v1/IPPrefixesWebhooks.md index ea1a3b4b1fdf..22f53a475943 100644 --- a/docs/v1/IPPrefixesWebhooks.md +++ b/docs/v1/IPPrefixesWebhooks.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| ----------------- | ----------------------- | ---------------------- | ---------- | | **prefixes_ipv4** | **Array<String>** | List of IPv4 prefixes. | [optional] | | **prefixes_ipv6** | **Array<String>** | List of IPv6 prefixes. | [optional] | @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::IPPrefixesWebhooks.new( prefixes_ipv6: null ) ``` - diff --git a/docs/v1/IPRanges.md b/docs/v1/IPRanges.md index e85cc6a4c6f7..80616275c076 100644 --- a/docs/v1/IPRanges.md +++ b/docs/v1/IPRanges.md @@ -2,17 +2,17 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **agents** | [**IPPrefixesAgents**](IPPrefixesAgents.md) | | [optional] | -| **api** | [**IPPrefixesAPI**](IPPrefixesAPI.md) | | [optional] | -| **apm** | [**IPPrefixesAPM**](IPPrefixesAPM.md) | | [optional] | -| **logs** | [**IPPrefixesLogs**](IPPrefixesLogs.md) | | [optional] | -| **modified** | **String** | Date when last updated, in the form `YYYY-MM-DD-hh-mm-ss`. | [optional] | -| **process** | [**IPPrefixesProcess**](IPPrefixesProcess.md) | | [optional] | -| **synthetics** | [**IPPrefixesSynthetics**](IPPrefixesSynthetics.md) | | [optional] | -| **version** | **Integer** | Version of the IP list. | [optional] | -| **webhooks** | [**IPPrefixesWebhooks**](IPPrefixesWebhooks.md) | | [optional] | +| Name | Type | Description | Notes | +| -------------- | --------------------------------------------------- | -------------------------------------------------------------------- | ---------- | +| **agents** | [**IPPrefixesAgents**](IPPrefixesAgents.md) | | [optional] | +| **api** | [**IPPrefixesAPI**](IPPrefixesAPI.md) | | [optional] | +| **apm** | [**IPPrefixesAPM**](IPPrefixesAPM.md) | | [optional] | +| **logs** | [**IPPrefixesLogs**](IPPrefixesLogs.md) | | [optional] | +| **modified** | **String** | Date when last updated, in the form `YYYY-MM-DD-hh-mm-ss`. | [optional] | +| **process** | [**IPPrefixesProcess**](IPPrefixesProcess.md) | | [optional] | +| **synthetics** | [**IPPrefixesSynthetics**](IPPrefixesSynthetics.md) | | [optional] | +| **version** | **Integer** | Version of the IP list. | [optional] | +| **webhooks** | [**IPPrefixesWebhooks**](IPPrefixesWebhooks.md) | | [optional] | ## Example @@ -31,4 +31,3 @@ instance = DatadogAPIClient::V1::IPRanges.new( webhooks: null ) ``` - diff --git a/docs/v1/IPRangesAPI.md b/docs/v1/IPRangesAPI.md index 5982e8bb83ce..cd6f2133494a 100644 --- a/docs/v1/IPRangesAPI.md +++ b/docs/v1/IPRangesAPI.md @@ -2,10 +2,9 @@ All URIs are relative to *https://api.datadoghq.com* -| Method | HTTP request | Description | -| ------ | ------------ | ----------- | -| [**get_ip_ranges**](IPRangesAPI.md#get_ip_ranges) | **GET** / | List IP Ranges | - +| Method | HTTP request | Description | +| ------------------------------------------------- | ------------ | -------------- | +| [**get_ip_ranges**](IPRangesAPI.md#get_ip_ranges) | **GET** / | List IP Ranges | ## get_ip_ranges @@ -62,4 +61,3 @@ No authorization required - **Content-Type**: Not defined - **Accept**: application/json - diff --git a/docs/v1/IdpFormData.md b/docs/v1/IdpFormData.md index afc001fc442a..363259be6a67 100644 --- a/docs/v1/IdpFormData.md +++ b/docs/v1/IdpFormData.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **idp_file** | **File** | The path to the XML metadata file you wish to upload. | | +| Name | Type | Description | Notes | +| ------------ | -------- | ----------------------------------------------------- | ----- | +| **idp_file** | **File** | The path to the XML metadata file you wish to upload. | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::IdpFormData.new( idp_file: null ) ``` - diff --git a/docs/v1/IdpResponse.md b/docs/v1/IdpResponse.md index f3e70f470811..d23646355d03 100644 --- a/docs/v1/IdpResponse.md +++ b/docs/v1/IdpResponse.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **message** | **String** | Identity provider response. | | +| Name | Type | Description | Notes | +| ----------- | ---------- | --------------------------- | ----- | +| **message** | **String** | Identity provider response. | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::IdpResponse.new( message: IdP metadata successfully uploaded for example org ) ``` - diff --git a/docs/v1/ImageWidgetDefinition.md b/docs/v1/ImageWidgetDefinition.md index c388c44b1199..3938dbf018ba 100644 --- a/docs/v1/ImageWidgetDefinition.md +++ b/docs/v1/ImageWidgetDefinition.md @@ -2,17 +2,17 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **has_background** | **Boolean** | Whether to display a background or not. | [optional][default to true] | -| **has_border** | **Boolean** | Whether to display a border or not. | [optional][default to true] | -| **horizontal_align** | [**WidgetHorizontalAlign**](WidgetHorizontalAlign.md) | | [optional] | -| **margin** | [**WidgetMargin**](WidgetMargin.md) | | [optional] | -| **sizing** | [**WidgetImageSizing**](WidgetImageSizing.md) | | [optional] | -| **type** | [**ImageWidgetDefinitionType**](ImageWidgetDefinitionType.md) | | [default to 'image'] | -| **url** | **String** | URL of the image. | | -| **url_dark_theme** | **String** | URL of the image in dark mode. | [optional] | -| **vertical_align** | [**WidgetVerticalAlign**](WidgetVerticalAlign.md) | | [optional] | +| Name | Type | Description | Notes | +| -------------------- | ------------------------------------------------------------- | --------------------------------------- | ---------------------------- | +| **has_background** | **Boolean** | Whether to display a background or not. | [optional][default to true] | +| **has_border** | **Boolean** | Whether to display a border or not. | [optional][default to true] | +| **horizontal_align** | [**WidgetHorizontalAlign**](WidgetHorizontalAlign.md) | | [optional] | +| **margin** | [**WidgetMargin**](WidgetMargin.md) | | [optional] | +| **sizing** | [**WidgetImageSizing**](WidgetImageSizing.md) | | [optional] | +| **type** | [**ImageWidgetDefinitionType**](ImageWidgetDefinitionType.md) | | [default to 'image'] | +| **url** | **String** | URL of the image. | | +| **url_dark_theme** | **String** | URL of the image in dark mode. | [optional] | +| **vertical_align** | [**WidgetVerticalAlign**](WidgetVerticalAlign.md) | | [optional] | ## Example @@ -31,4 +31,3 @@ instance = DatadogAPIClient::V1::ImageWidgetDefinition.new( vertical_align: null ) ``` - diff --git a/docs/v1/ImageWidgetDefinitionType.md b/docs/v1/ImageWidgetDefinitionType.md index c3846bec7b5c..c1727117f72a 100644 --- a/docs/v1/ImageWidgetDefinitionType.md +++ b/docs/v1/ImageWidgetDefinitionType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::ImageWidgetDefinitionType.new() ``` - diff --git a/docs/v1/IntakePayloadAccepted.md b/docs/v1/IntakePayloadAccepted.md index 1fc9d9b48179..72c916bf8bb7 100644 --- a/docs/v1/IntakePayloadAccepted.md +++ b/docs/v1/IntakePayloadAccepted.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| ---------- | ---------- | --------------------------------- | ---------- | | **status** | **String** | The status of the intake payload. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::IntakePayloadAccepted.new( status: ok ) ``` - diff --git a/docs/v1/KeyManagementAPI.md b/docs/v1/KeyManagementAPI.md index f1ac1a437021..7237f7b9b184 100644 --- a/docs/v1/KeyManagementAPI.md +++ b/docs/v1/KeyManagementAPI.md @@ -2,19 +2,18 @@ All URIs are relative to *https://api.datadoghq.com* -| Method | HTTP request | Description | -| ------ | ------------ | ----------- | -| [**create_api_key**](KeyManagementAPI.md#create_api_key) | **POST** /api/v1/api_key | Create an API key | -| [**create_application_key**](KeyManagementAPI.md#create_application_key) | **POST** /api/v1/application_key | Create an application key | -| [**delete_api_key**](KeyManagementAPI.md#delete_api_key) | **DELETE** /api/v1/api_key/{key} | Delete an API key | +| Method | HTTP request | Description | +| ------------------------------------------------------------------------ | ---------------------------------------- | ------------------------- | +| [**create_api_key**](KeyManagementAPI.md#create_api_key) | **POST** /api/v1/api_key | Create an API key | +| [**create_application_key**](KeyManagementAPI.md#create_application_key) | **POST** /api/v1/application_key | Create an application key | +| [**delete_api_key**](KeyManagementAPI.md#delete_api_key) | **DELETE** /api/v1/api_key/{key} | Delete an API key | | [**delete_application_key**](KeyManagementAPI.md#delete_application_key) | **DELETE** /api/v1/application_key/{key} | Delete an application key | -| [**get_api_key**](KeyManagementAPI.md#get_api_key) | **GET** /api/v1/api_key/{key} | Get API key | -| [**get_application_key**](KeyManagementAPI.md#get_application_key) | **GET** /api/v1/application_key/{key} | Get an application key | -| [**list_api_keys**](KeyManagementAPI.md#list_api_keys) | **GET** /api/v1/api_key | Get all API keys | -| [**list_application_keys**](KeyManagementAPI.md#list_application_keys) | **GET** /api/v1/application_key | Get all application keys | -| [**update_api_key**](KeyManagementAPI.md#update_api_key) | **PUT** /api/v1/api_key/{key} | Edit an API key | -| [**update_application_key**](KeyManagementAPI.md#update_application_key) | **PUT** /api/v1/application_key/{key} | Edit an application key | - +| [**get_api_key**](KeyManagementAPI.md#get_api_key) | **GET** /api/v1/api_key/{key} | Get API key | +| [**get_application_key**](KeyManagementAPI.md#get_application_key) | **GET** /api/v1/application_key/{key} | Get an application key | +| [**list_api_keys**](KeyManagementAPI.md#list_api_keys) | **GET** /api/v1/api_key | Get all API keys | +| [**list_application_keys**](KeyManagementAPI.md#list_application_keys) | **GET** /api/v1/application_key | Get all application keys | +| [**update_api_key**](KeyManagementAPI.md#update_api_key) | **PUT** /api/v1/api_key/{key} | Edit an API key | +| [**update_application_key**](KeyManagementAPI.md#update_application_key) | **PUT** /api/v1/application_key/{key} | Edit an application key | ## create_api_key @@ -27,7 +26,7 @@ Creates an API key with a given name. ```ruby require 'datadog_api_client' api_instance = DatadogAPIClient::V1::KeyManagementAPI.new -body = DatadogAPIClient::V1::ApiKey.new # ApiKey | +body = DatadogAPIClient::V1::ApiKey.new # ApiKey | begin # Create an API key @@ -58,9 +57,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**ApiKey**](ApiKey.md) | | | +| Name | Type | Description | Notes | +| -------- | ----------------------- | ----------- | ----- | +| **body** | [**ApiKey**](ApiKey.md) | | | ### Return type @@ -75,7 +74,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## create_application_key > create_application_key(body) @@ -87,7 +85,7 @@ Create an application key with a given name. ```ruby require 'datadog_api_client' api_instance = DatadogAPIClient::V1::KeyManagementAPI.new -body = DatadogAPIClient::V1::ApplicationKey.new # ApplicationKey | +body = DatadogAPIClient::V1::ApplicationKey.new # ApplicationKey | begin # Create an application key @@ -118,9 +116,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**ApplicationKey**](ApplicationKey.md) | | | +| Name | Type | Description | Notes | +| -------- | --------------------------------------- | ----------- | ----- | +| **body** | [**ApplicationKey**](ApplicationKey.md) | | | ### Return type @@ -135,7 +133,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## delete_api_key > delete_api_key(key) @@ -178,9 +175,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **key** | **String** | The specific API key you are working with. | | +| Name | Type | Description | Notes | +| ------- | ---------- | ------------------------------------------ | ----- | +| **key** | **String** | The specific API key you are working with. | | ### Return type @@ -195,7 +192,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## delete_application_key > delete_application_key(key) @@ -238,9 +234,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **key** | **String** | The specific APP key you are working with. | | +| Name | Type | Description | Notes | +| ------- | ---------- | ------------------------------------------ | ----- | +| **key** | **String** | The specific APP key you are working with. | | ### Return type @@ -255,7 +251,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## get_api_key > get_api_key(key) @@ -298,9 +293,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **key** | **String** | The specific API key you are working with. | | +| Name | Type | Description | Notes | +| ------- | ---------- | ------------------------------------------ | ----- | +| **key** | **String** | The specific API key you are working with. | | ### Return type @@ -315,7 +310,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## get_application_key > get_application_key(key) @@ -358,9 +352,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **key** | **String** | The specific APP key you are working with. | | +| Name | Type | Description | Notes | +| ------- | ---------- | ------------------------------------------ | ----- | +| **key** | **String** | The specific APP key you are working with. | | ### Return type @@ -375,7 +369,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## list_api_keys > list_api_keys @@ -432,7 +425,6 @@ This endpoint does not need any parameter. - **Content-Type**: Not defined - **Accept**: application/json - ## list_application_keys > list_application_keys @@ -489,7 +481,6 @@ This endpoint does not need any parameter. - **Content-Type**: Not defined - **Accept**: application/json - ## update_api_key > update_api_key(key, body) @@ -502,7 +493,7 @@ Edit an API key name. require 'datadog_api_client' api_instance = DatadogAPIClient::V1::KeyManagementAPI.new key = 'key_example' # String | The specific API key you are working with. -body = DatadogAPIClient::V1::ApiKey.new # ApiKey | +body = DatadogAPIClient::V1::ApiKey.new # ApiKey | begin # Edit an API key @@ -533,10 +524,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **key** | **String** | The specific API key you are working with. | | -| **body** | [**ApiKey**](ApiKey.md) | | | +| Name | Type | Description | Notes | +| -------- | ----------------------- | ------------------------------------------ | ----- | +| **key** | **String** | The specific API key you are working with. | | +| **body** | [**ApiKey**](ApiKey.md) | | | ### Return type @@ -551,7 +542,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## update_application_key > update_application_key(key, body) @@ -564,7 +554,7 @@ Edit an application key name. require 'datadog_api_client' api_instance = DatadogAPIClient::V1::KeyManagementAPI.new key = 'key_example' # String | The specific APP key you are working with. -body = DatadogAPIClient::V1::ApplicationKey.new # ApplicationKey | +body = DatadogAPIClient::V1::ApplicationKey.new # ApplicationKey | begin # Edit an application key @@ -595,10 +585,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **key** | **String** | The specific APP key you are working with. | | -| **body** | [**ApplicationKey**](ApplicationKey.md) | | | +| Name | Type | Description | Notes | +| -------- | --------------------------------------- | ------------------------------------------ | ----- | +| **key** | **String** | The specific APP key you are working with. | | +| **body** | [**ApplicationKey**](ApplicationKey.md) | | | ### Return type @@ -612,4 +602,3 @@ end - **Content-Type**: application/json - **Accept**: application/json - diff --git a/docs/v1/ListStreamColumn.md b/docs/v1/ListStreamColumn.md index 291ee70afb0b..a85063f89714 100644 --- a/docs/v1/ListStreamColumn.md +++ b/docs/v1/ListStreamColumn.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **field** | **String** | Widget column field. | | -| **width** | [**ListStreamColumnWidth**](ListStreamColumnWidth.md) | | | +| Name | Type | Description | Notes | +| --------- | ----------------------------------------------------- | -------------------- | ----- | +| **field** | **String** | Widget column field. | | +| **width** | [**ListStreamColumnWidth**](ListStreamColumnWidth.md) | | | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::ListStreamColumn.new( width: null ) ``` - diff --git a/docs/v1/ListStreamColumnWidth.md b/docs/v1/ListStreamColumnWidth.md index 1612f5626ff0..a8b9a3882395 100644 --- a/docs/v1/ListStreamColumnWidth.md +++ b/docs/v1/ListStreamColumnWidth.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::ListStreamColumnWidth.new() ``` - diff --git a/docs/v1/ListStreamQuery.md b/docs/v1/ListStreamQuery.md index 3b79990a966d..b82f30bb3084 100644 --- a/docs/v1/ListStreamQuery.md +++ b/docs/v1/ListStreamQuery.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data_source** | [**ListStreamSource**](ListStreamSource.md) | | [default to 'issue_stream'] | -| **indexes** | **Array<String>** | List of indexes. | [optional] | -| **query_string** | **String** | Widget query. | | +| Name | Type | Description | Notes | +| ---------------- | ------------------------------------------- | ---------------- | ----------------------------------- | +| **data_source** | [**ListStreamSource**](ListStreamSource.md) | | [default to 'issue_stream'] | +| **indexes** | **Array<String>** | List of indexes. | [optional] | +| **query_string** | **String** | Widget query. | | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::ListStreamQuery.new( query_string: @service:app ) ``` - diff --git a/docs/v1/ListStreamResponseFormat.md b/docs/v1/ListStreamResponseFormat.md index f4c25921f22d..f050db0d7cb4 100644 --- a/docs/v1/ListStreamResponseFormat.md +++ b/docs/v1/ListStreamResponseFormat.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::ListStreamResponseFormat.new() ``` - diff --git a/docs/v1/ListStreamSource.md b/docs/v1/ListStreamSource.md index 6fd6492180b8..a469bae2262f 100644 --- a/docs/v1/ListStreamSource.md +++ b/docs/v1/ListStreamSource.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::ListStreamSource.new() ``` - diff --git a/docs/v1/ListStreamWidgetDefinition.md b/docs/v1/ListStreamWidgetDefinition.md index 663c7fd134d6..33ec58ed406c 100644 --- a/docs/v1/ListStreamWidgetDefinition.md +++ b/docs/v1/ListStreamWidgetDefinition.md @@ -2,16 +2,16 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **legend_size** | **String** | Available legend sizes for a widget. Should be one of \"0\", \"2\", \"4\", \"8\", \"16\", or \"auto\". | [optional] | -| **requests** | [**Array<ListStreamWidgetRequest>**](ListStreamWidgetRequest.md) | Request payload used to query items. | | -| **show_legend** | **Boolean** | Whether or not to display the legend on this widget. | [optional] | -| **time** | [**WidgetTime**](WidgetTime.md) | | [optional] | -| **title** | **String** | Title of the widget. | [optional] | -| **title_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | -| **title_size** | **String** | Size of the title. | [optional] | -| **type** | [**ListStreamWidgetDefinitionType**](ListStreamWidgetDefinitionType.md) | | [default to 'list_stream'] | +| Name | Type | Description | Notes | +| --------------- | ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------- | +| **legend_size** | **String** | Available legend sizes for a widget. Should be one of \"0\", \"2\", \"4\", \"8\", \"16\", or \"auto\". | [optional] | +| **requests** | [**Array<ListStreamWidgetRequest>**](ListStreamWidgetRequest.md) | Request payload used to query items. | | +| **show_legend** | **Boolean** | Whether or not to display the legend on this widget. | [optional] | +| **time** | [**WidgetTime**](WidgetTime.md) | | [optional] | +| **title** | **String** | Title of the widget. | [optional] | +| **title_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | +| **title_size** | **String** | Size of the title. | [optional] | +| **type** | [**ListStreamWidgetDefinitionType**](ListStreamWidgetDefinitionType.md) | | [default to 'list_stream'] | ## Example @@ -29,4 +29,3 @@ instance = DatadogAPIClient::V1::ListStreamWidgetDefinition.new( type: null ) ``` - diff --git a/docs/v1/ListStreamWidgetDefinitionType.md b/docs/v1/ListStreamWidgetDefinitionType.md index 100697ddf275..bb0a2a52a095 100644 --- a/docs/v1/ListStreamWidgetDefinitionType.md +++ b/docs/v1/ListStreamWidgetDefinitionType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::ListStreamWidgetDefinitionType.new() ``` - diff --git a/docs/v1/ListStreamWidgetRequest.md b/docs/v1/ListStreamWidgetRequest.md index 1a6df3b7f089..864811a8fc8b 100644 --- a/docs/v1/ListStreamWidgetRequest.md +++ b/docs/v1/ListStreamWidgetRequest.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **columns** | [**Array<ListStreamColumn>**](ListStreamColumn.md) | Widget columns. | | -| **query** | [**ListStreamQuery**](ListStreamQuery.md) | | | -| **response_format** | [**ListStreamResponseFormat**](ListStreamResponseFormat.md) | | | +| Name | Type | Description | Notes | +| ------------------- | ----------------------------------------------------------- | --------------- | ----- | +| **columns** | [**Array<ListStreamColumn>**](ListStreamColumn.md) | Widget columns. | | +| **query** | [**ListStreamQuery**](ListStreamQuery.md) | | | +| **response_format** | [**ListStreamResponseFormat**](ListStreamResponseFormat.md) | | | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::ListStreamWidgetRequest.new( response_format: null ) ``` - diff --git a/docs/v1/Log.md b/docs/v1/Log.md index ded73d9e9680..42536fe1e9e7 100644 --- a/docs/v1/Log.md +++ b/docs/v1/Log.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **content** | [**LogContent**](LogContent.md) | | [optional] | -| **id** | **String** | Unique ID of the Log. | [optional] | +| Name | Type | Description | Notes | +| ----------- | ------------------------------- | --------------------- | ---------- | +| **content** | [**LogContent**](LogContent.md) | | [optional] | +| **id** | **String** | Unique ID of the Log. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::Log.new( id: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA ) ``` - diff --git a/docs/v1/LogContent.md b/docs/v1/LogContent.md index ffe5e8530fce..cf27a0b4dbf2 100644 --- a/docs/v1/LogContent.md +++ b/docs/v1/LogContent.md @@ -2,14 +2,14 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | **Hash<String, Object>** | JSON object of attributes from your log. | [optional] | -| **host** | **String** | Name of the machine from where the logs are being sent. | [optional] | -| **message** | **String** | The message [reserved attribute](https://docs.datadoghq.com/logs/log_collection/#reserved-attributes) of your log. By default, Datadog ingests the value of the message attribute as the body of the log entry. That value is then highlighted and displayed in the Logstream, where it is indexed for full text search. | [optional] | -| **service** | **String** | The name of the application or service generating the log events. It is used to switch from Logs to APM, so make sure you define the same value when you use both products. | [optional] | -| **tags** | **Array<Object>** | Array of tags associated with your log. | [optional] | -| **timestamp** | **Time** | Timestamp of your log. | [optional] | +| Name | Type | Description | Notes | +| -------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------- | +| **attributes** | **Hash<String, Object>** | JSON object of attributes from your log. | [optional] | +| **host** | **String** | Name of the machine from where the logs are being sent. | [optional] | +| **message** | **String** | The message [reserved attribute](https://docs.datadoghq.com/logs/log_collection/#reserved-attributes) of your log. By default, Datadog ingests the value of the message attribute as the body of the log entry. That value is then highlighted and displayed in the Logstream, where it is indexed for full text search. | [optional] | +| **service** | **String** | The name of the application or service generating the log events. It is used to switch from Logs to APM, so make sure you define the same value when you use both products. | [optional] | +| **tags** | **Array<Object>** | Array of tags associated with your log. | [optional] | +| **timestamp** | **Time** | Timestamp of your log. | [optional] | ## Example @@ -25,4 +25,3 @@ instance = DatadogAPIClient::V1::LogContent.new( timestamp: 2020-05-26T13:36:14Z ) ``` - diff --git a/docs/v1/LogQueryDefinition.md b/docs/v1/LogQueryDefinition.md index 68f3b887b3f7..fa95ed68a34d 100644 --- a/docs/v1/LogQueryDefinition.md +++ b/docs/v1/LogQueryDefinition.md @@ -2,13 +2,13 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **compute** | [**LogsQueryCompute**](LogsQueryCompute.md) | | [optional] | -| **group_by** | [**Array<LogQueryDefinitionGroupBy>**](LogQueryDefinitionGroupBy.md) | List of tag prefixes to group by in the case of a cluster check. | [optional] | -| **index** | **String** | A coma separated-list of index names. Use \"*\" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) | [optional] | -| **multi_compute** | [**Array<LogsQueryCompute>**](LogsQueryCompute.md) | This field is mutually exclusive with `compute`. | [optional] | -| **search** | [**LogQueryDefinitionSearch**](LogQueryDefinitionSearch.md) | | [optional] | +| Name | Type | Description | Notes | +| ----------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **compute** | [**LogsQueryCompute**](LogsQueryCompute.md) | | [optional] | +| **group_by** | [**Array<LogQueryDefinitionGroupBy>**](LogQueryDefinitionGroupBy.md) | List of tag prefixes to group by in the case of a cluster check. | [optional] | +| **index** | **String** | A coma separated-list of index names. Use \"\*\" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes) | [optional] | +| **multi_compute** | [**Array<LogsQueryCompute>**](LogsQueryCompute.md) | This field is mutually exclusive with `compute`. | [optional] | +| **search** | [**LogQueryDefinitionSearch**](LogQueryDefinitionSearch.md) | | [optional] | ## Example @@ -23,4 +23,3 @@ instance = DatadogAPIClient::V1::LogQueryDefinition.new( search: null ) ``` - diff --git a/docs/v1/LogQueryDefinitionGroupBy.md b/docs/v1/LogQueryDefinitionGroupBy.md index 73a88e0d5922..14164c845c05 100644 --- a/docs/v1/LogQueryDefinitionGroupBy.md +++ b/docs/v1/LogQueryDefinitionGroupBy.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **facet** | **String** | Facet name. | | -| **limit** | **Integer** | Maximum number of items in the group. | [optional] | -| **sort** | [**LogQueryDefinitionGroupBySort**](LogQueryDefinitionGroupBySort.md) | | [optional] | +| Name | Type | Description | Notes | +| --------- | --------------------------------------------------------------------- | ------------------------------------- | ---------- | +| **facet** | **String** | Facet name. | | +| **limit** | **Integer** | Maximum number of items in the group. | [optional] | +| **sort** | [**LogQueryDefinitionGroupBySort**](LogQueryDefinitionGroupBySort.md) | | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::LogQueryDefinitionGroupBy.new( sort: null ) ``` - diff --git a/docs/v1/LogQueryDefinitionGroupBySort.md b/docs/v1/LogQueryDefinitionGroupBySort.md index 497774b5f78c..5164fa81efa2 100644 --- a/docs/v1/LogQueryDefinitionGroupBySort.md +++ b/docs/v1/LogQueryDefinitionGroupBySort.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **aggregation** | **String** | The aggregation method. | | -| **facet** | **String** | Facet name. | [optional] | -| **order** | [**WidgetSort**](WidgetSort.md) | | | +| Name | Type | Description | Notes | +| --------------- | ------------------------------- | ----------------------- | ---------- | +| **aggregation** | **String** | The aggregation method. | | +| **facet** | **String** | Facet name. | [optional] | +| **order** | [**WidgetSort**](WidgetSort.md) | | | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::LogQueryDefinitionGroupBySort.new( order: null ) ``` - diff --git a/docs/v1/LogQueryDefinitionSearch.md b/docs/v1/LogQueryDefinitionSearch.md index ce195f0a9c20..1d5053fa321f 100644 --- a/docs/v1/LogQueryDefinitionSearch.md +++ b/docs/v1/LogQueryDefinitionSearch.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **query** | **String** | Search value to apply. | | +| Name | Type | Description | Notes | +| --------- | ---------- | ---------------------- | ----- | +| **query** | **String** | Search value to apply. | | ## Example @@ -12,7 +12,6 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::LogQueryDefinitionSearch.new( - query: + query: ) ``` - diff --git a/docs/v1/LogStreamWidgetDefinition.md b/docs/v1/LogStreamWidgetDefinition.md index 68a0235446af..b91e0a2dc3ff 100644 --- a/docs/v1/LogStreamWidgetDefinition.md +++ b/docs/v1/LogStreamWidgetDefinition.md @@ -2,21 +2,21 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **columns** | **Array<String>** | Which columns to display on the widget. | [optional] | -| **indexes** | **Array<String>** | An array of index names to query in the stream. Use [] to query all indexes at once. | [optional] | -| **logset** | **String** | ID of the log set to use. | [optional] | -| **message_display** | [**WidgetMessageDisplay**](WidgetMessageDisplay.md) | | [optional] | -| **query** | **String** | Query to filter the log stream with. | [optional] | -| **show_date_column** | **Boolean** | Whether to show the date column or not | [optional] | -| **show_message_column** | **Boolean** | Whether to show the message column or not | [optional] | -| **sort** | [**WidgetFieldSort**](WidgetFieldSort.md) | | [optional] | -| **time** | [**WidgetTime**](WidgetTime.md) | | [optional] | -| **title** | **String** | Title of the widget. | [optional] | -| **title_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | -| **title_size** | **String** | Size of the title. | [optional] | -| **type** | [**LogStreamWidgetDefinitionType**](LogStreamWidgetDefinitionType.md) | | [default to 'log_stream'] | +| Name | Type | Description | Notes | +| ----------------------- | --------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | --------------------------------- | +| **columns** | **Array<String>** | Which columns to display on the widget. | [optional] | +| **indexes** | **Array<String>** | An array of index names to query in the stream. Use [] to query all indexes at once. | [optional] | +| **logset** | **String** | ID of the log set to use. | [optional] | +| **message_display** | [**WidgetMessageDisplay**](WidgetMessageDisplay.md) | | [optional] | +| **query** | **String** | Query to filter the log stream with. | [optional] | +| **show_date_column** | **Boolean** | Whether to show the date column or not | [optional] | +| **show_message_column** | **Boolean** | Whether to show the message column or not | [optional] | +| **sort** | [**WidgetFieldSort**](WidgetFieldSort.md) | | [optional] | +| **time** | [**WidgetTime**](WidgetTime.md) | | [optional] | +| **title** | **String** | Title of the widget. | [optional] | +| **title_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | +| **title_size** | **String** | Size of the title. | [optional] | +| **type** | [**LogStreamWidgetDefinitionType**](LogStreamWidgetDefinitionType.md) | | [default to 'log_stream'] | ## Example @@ -39,4 +39,3 @@ instance = DatadogAPIClient::V1::LogStreamWidgetDefinition.new( type: null ) ``` - diff --git a/docs/v1/LogStreamWidgetDefinitionType.md b/docs/v1/LogStreamWidgetDefinitionType.md index c46472c81f5e..f602f2bb4541 100644 --- a/docs/v1/LogStreamWidgetDefinitionType.md +++ b/docs/v1/LogStreamWidgetDefinitionType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::LogStreamWidgetDefinitionType.new() ``` - diff --git a/docs/v1/LogsAPI.md b/docs/v1/LogsAPI.md index 31c2b0191b17..0138726d9285 100644 --- a/docs/v1/LogsAPI.md +++ b/docs/v1/LogsAPI.md @@ -2,11 +2,10 @@ All URIs are relative to *https://api.datadoghq.com* -| Method | HTTP request | Description | -| ------ | ------------ | ----------- | -| [**list_logs**](LogsAPI.md#list_logs) | **POST** /api/v1/logs-queries/list | Search logs | -| [**submit_log**](LogsAPI.md#submit_log) | **POST** /v1/input | Send logs | - +| Method | HTTP request | Description | +| --------------------------------------- | ---------------------------------- | ----------- | +| [**list_logs**](LogsAPI.md#list_logs) | **POST** /api/v1/logs-queries/list | Search logs | +| [**submit_log**](LogsAPI.md#submit_log) | **POST** /v1/input | Send logs | ## list_logs @@ -58,9 +57,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**LogsListRequest**](LogsListRequest.md) | Logs filter | | +| Name | Type | Description | Notes | +| -------- | ----------------------------------------- | ----------- | ----- | +| **body** | [**LogsListRequest**](LogsListRequest.md) | Logs filter | | ### Return type @@ -75,7 +74,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## submit_log > Object submit_log(body, opts) @@ -87,6 +85,7 @@ Send your logs to your Datadog platform over HTTP. Limits per HTTP request are: - Maximum array size if sending multiple logs in an array: 1000 entries Any log exceeding 1MB is accepted and truncated by Datadog: + - For a single log request, the API truncates the log at 1MB and returns a 2xx. - For a multi-logs request, the API processes all logs, truncates only logs larger than 1MB, and returns a 2xx. @@ -94,6 +93,7 @@ Datadog recommends sending your logs compressed. Add the `Content-Encoding: gzip` header to the request when sending compressed logs. The status codes answered by the HTTP API are: + - 200: OK - 400: Bad request (likely an issue in the payload formatting) - 403: Permission issue (likely using an invalid API Key) @@ -140,11 +140,11 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**Array<HTTPLogItem>**](HTTPLogItem.md) | Log to send (JSON format). | | -| **content_encoding** | **ContentEncoding** | HTTP header used to compress the media-type. | [optional] | -| **ddtags** | **String** | Log tags can be passed as query parameters with `text/plain` content type. | [optional] | +| Name | Type | Description | Notes | +| -------------------- | ---------------------------------------------- | ------------------------------------------------------------------------------------ | ---------- | +| **body** | [**Array<HTTPLogItem>**](HTTPLogItem.md) | Log to send (JSON format). | | +| **content_encoding** | **ContentEncoding** | HTTP header used to compress the media-type. | [optional] | +| **ddtags** | **String** | Log tags can be passed as query parameters with `text/plain` content type. | [optional] | ### Return type @@ -158,4 +158,3 @@ end - **Content-Type**: application/json, application/logplex-1, text/plain - **Accept**: application/json - diff --git a/docs/v1/LogsAPIError.md b/docs/v1/LogsAPIError.md index a586153ba410..2a6c7d9ac1ce 100644 --- a/docs/v1/LogsAPIError.md +++ b/docs/v1/LogsAPIError.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **code** | **String** | Code identifying the error | [optional] | -| **details** | [**Array<LogsAPIError>**](LogsAPIError.md) | Additional error details | [optional] | -| **message** | **String** | Error message | [optional] | +| Name | Type | Description | Notes | +| ----------- | ------------------------------------------------ | -------------------------- | ---------- | +| **code** | **String** | Code identifying the error | [optional] | +| **details** | [**Array<LogsAPIError>**](LogsAPIError.md) | Additional error details | [optional] | +| **message** | **String** | Error message | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::LogsAPIError.new( message: null ) ``` - diff --git a/docs/v1/LogsAPIErrorResponse.md b/docs/v1/LogsAPIErrorResponse.md index 78bddce88821..54ddff28f9e2 100644 --- a/docs/v1/LogsAPIErrorResponse.md +++ b/docs/v1/LogsAPIErrorResponse.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **error** | [**LogsAPIError**](LogsAPIError.md) | | [optional] | +| Name | Type | Description | Notes | +| --------- | ----------------------------------- | ----------- | ---------- | +| **error** | [**LogsAPIError**](LogsAPIError.md) | | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::LogsAPIErrorResponse.new( error: null ) ``` - diff --git a/docs/v1/LogsArithmeticProcessor.md b/docs/v1/LogsArithmeticProcessor.md index ae4a5fd2be2b..460af1f86a15 100644 --- a/docs/v1/LogsArithmeticProcessor.md +++ b/docs/v1/LogsArithmeticProcessor.md @@ -2,14 +2,14 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **expression** | **String** | Arithmetic operation between one or more log attributes. | | -| **is_enabled** | **Boolean** | Whether or not the processor is enabled. | [optional][default to false] | -| **is_replace_missing** | **Boolean** | If `true`, it replaces all missing attributes of expression by `0`, `false` skip the operation if an attribute is missing. | [optional][default to false] | -| **name** | **String** | Name of the processor. | [optional] | -| **target** | **String** | Name of the attribute that contains the result of the arithmetic operation. | | -| **type** | [**LogsArithmeticProcessorType**](LogsArithmeticProcessorType.md) | | [default to 'arithmetic-processor'] | +| Name | Type | Description | Notes | +| ---------------------- | ----------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- | +| **expression** | **String** | Arithmetic operation between one or more log attributes. | | +| **is_enabled** | **Boolean** | Whether or not the processor is enabled. | [optional][default to false] | +| **is_replace_missing** | **Boolean** | If `true`, it replaces all missing attributes of expression by `0`, `false` skip the operation if an attribute is missing. | [optional][default to false] | +| **name** | **String** | Name of the processor. | [optional] | +| **target** | **String** | Name of the attribute that contains the result of the arithmetic operation. | | +| **type** | [**LogsArithmeticProcessorType**](LogsArithmeticProcessorType.md) | | [default to 'arithmetic-processor'] | ## Example @@ -25,4 +25,3 @@ instance = DatadogAPIClient::V1::LogsArithmeticProcessor.new( type: null ) ``` - diff --git a/docs/v1/LogsArithmeticProcessorType.md b/docs/v1/LogsArithmeticProcessorType.md index 066453e60b3f..972f1b7d60dc 100644 --- a/docs/v1/LogsArithmeticProcessorType.md +++ b/docs/v1/LogsArithmeticProcessorType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::LogsArithmeticProcessorType.new() ``` - diff --git a/docs/v1/LogsAttributeRemapper.md b/docs/v1/LogsAttributeRemapper.md index 8b540fff3396..ca5fe618b286 100644 --- a/docs/v1/LogsAttributeRemapper.md +++ b/docs/v1/LogsAttributeRemapper.md @@ -2,18 +2,18 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **is_enabled** | **Boolean** | Whether or not the processor is enabled. | [optional][default to false] | -| **name** | **String** | Name of the processor. | [optional] | -| **override_on_conflict** | **Boolean** | Override or not the target element if already set, | [optional][default to false] | -| **preserve_source** | **Boolean** | Remove or preserve the remapped source element. | [optional][default to false] | -| **source_type** | **String** | Defines if the sources are from log `attribute` or `tag`. | [optional][default to 'attribute'] | -| **sources** | **Array<String>** | Array of source attributes. | | -| **target** | **String** | Final attribute or tag name to remap the sources to. | | -| **target_format** | [**TargetFormatType**](TargetFormatType.md) | | [optional] | -| **target_type** | **String** | Defines if the final attribute or tag name is from log `attribute` or `tag`. | [optional][default to 'attribute'] | -| **type** | [**LogsAttributeRemapperType**](LogsAttributeRemapperType.md) | | [default to 'attribute-remapper'] | +| Name | Type | Description | Notes | +| ------------------------ | ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ | ------------------------------------------ | +| **is_enabled** | **Boolean** | Whether or not the processor is enabled. | [optional][default to false] | +| **name** | **String** | Name of the processor. | [optional] | +| **override_on_conflict** | **Boolean** | Override or not the target element if already set, | [optional][default to false] | +| **preserve_source** | **Boolean** | Remove or preserve the remapped source element. | [optional][default to false] | +| **source_type** | **String** | Defines if the sources are from log `attribute` or `tag`. | [optional][default to 'attribute'] | +| **sources** | **Array<String>** | Array of source attributes. | | +| **target** | **String** | Final attribute or tag name to remap the sources to. | | +| **target_format** | [**TargetFormatType**](TargetFormatType.md) | | [optional] | +| **target_type** | **String** | Defines if the final attribute or tag name is from log `attribute` or `tag`. | [optional][default to 'attribute'] | +| **type** | [**LogsAttributeRemapperType**](LogsAttributeRemapperType.md) | | [default to 'attribute-remapper'] | ## Example @@ -33,4 +33,3 @@ instance = DatadogAPIClient::V1::LogsAttributeRemapper.new( type: null ) ``` - diff --git a/docs/v1/LogsAttributeRemapperType.md b/docs/v1/LogsAttributeRemapperType.md index d6b2e07a16f3..4633e1c46016 100644 --- a/docs/v1/LogsAttributeRemapperType.md +++ b/docs/v1/LogsAttributeRemapperType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::LogsAttributeRemapperType.new() ``` - diff --git a/docs/v1/LogsByRetention.md b/docs/v1/LogsByRetention.md index 0110c1502559..37f5e4c9567c 100644 --- a/docs/v1/LogsByRetention.md +++ b/docs/v1/LogsByRetention.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **orgs** | [**LogsByRetentionOrgs**](LogsByRetentionOrgs.md) | | [optional] | -| **usage** | [**Array<LogsRetentionAggSumUsage>**](LogsRetentionAggSumUsage.md) | Aggregated index logs usage for each retention period with usage. | [optional] | -| **usage_by_month** | [**LogsByRetentionMonthlyUsage**](LogsByRetentionMonthlyUsage.md) | | [optional] | +| Name | Type | Description | Notes | +| ------------------ | ------------------------------------------------------------------------ | ----------------------------------------------------------------- | ---------- | +| **orgs** | [**LogsByRetentionOrgs**](LogsByRetentionOrgs.md) | | [optional] | +| **usage** | [**Array<LogsRetentionAggSumUsage>**](LogsRetentionAggSumUsage.md) | Aggregated index logs usage for each retention period with usage. | [optional] | +| **usage_by_month** | [**LogsByRetentionMonthlyUsage**](LogsByRetentionMonthlyUsage.md) | | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::LogsByRetention.new( usage_by_month: null ) ``` - diff --git a/docs/v1/LogsByRetentionMonthlyUsage.md b/docs/v1/LogsByRetentionMonthlyUsage.md index c60ab500e502..9d01f66a967f 100644 --- a/docs/v1/LogsByRetentionMonthlyUsage.md +++ b/docs/v1/LogsByRetentionMonthlyUsage.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **date** | **String** | The month for the usage. | [optional] | +| Name | Type | Description | Notes | +| --------- | ------------------------------------------------------------------ | ----------------------------------------------------------- | ---------- | +| **date** | **String** | The month for the usage. | [optional] | | **usage** | [**Array<LogsRetentionSumUsage>**](LogsRetentionSumUsage.md) | Indexed logs usage for each active retention for the month. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::LogsByRetentionMonthlyUsage.new( usage: null ) ``` - diff --git a/docs/v1/LogsByRetentionOrgUsage.md b/docs/v1/LogsByRetentionOrgUsage.md index caa692d2b157..8c87d78d363b 100644 --- a/docs/v1/LogsByRetentionOrgUsage.md +++ b/docs/v1/LogsByRetentionOrgUsage.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| --------- | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ---------- | | **usage** | [**Array<LogsRetentionSumUsage>**](LogsRetentionSumUsage.md) | Indexed logs usage for each active retention for the organization. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::LogsByRetentionOrgUsage.new( usage: null ) ``` - diff --git a/docs/v1/LogsByRetentionOrgs.md b/docs/v1/LogsByRetentionOrgs.md index 1f183e7822f2..8132ccdcbc32 100644 --- a/docs/v1/LogsByRetentionOrgs.md +++ b/docs/v1/LogsByRetentionOrgs.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| --------- | ---------------------------------------------------------------------- | ------------------------------------------------- | ---------- | | **usage** | [**Array<LogsByRetentionOrgUsage>**](LogsByRetentionOrgUsage.md) | Indexed logs usage summary for each organization. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::LogsByRetentionOrgs.new( usage: null ) ``` - diff --git a/docs/v1/LogsCategoryProcessor.md b/docs/v1/LogsCategoryProcessor.md index e017da3ee171..3650c82764b6 100644 --- a/docs/v1/LogsCategoryProcessor.md +++ b/docs/v1/LogsCategoryProcessor.md @@ -2,13 +2,13 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **categories** | [**Array<LogsCategoryProcessorCategory>**](LogsCategoryProcessorCategory.md) | Array of filters to match or not a log and their corresponding `name`to assign a custom value to the log. | | -| **is_enabled** | **Boolean** | Whether or not the processor is enabled. | [optional][default to false] | -| **name** | **String** | Name of the processor. | [optional] | -| **target** | **String** | Name of the target attribute which value is defined by the matching category. | | -| **type** | [**LogsCategoryProcessorType**](LogsCategoryProcessorType.md) | | [default to 'category-processor'] | +| Name | Type | Description | Notes | +| -------------- | ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | +| **categories** | [**Array<LogsCategoryProcessorCategory>**](LogsCategoryProcessorCategory.md) | Array of filters to match or not a log and their corresponding `name`to assign a custom value to the log. | | +| **is_enabled** | **Boolean** | Whether or not the processor is enabled. | [optional][default to false] | +| **name** | **String** | Name of the processor. | [optional] | +| **target** | **String** | Name of the target attribute which value is defined by the matching category. | | +| **type** | [**LogsCategoryProcessorType**](LogsCategoryProcessorType.md) | | [default to 'category-processor'] | ## Example @@ -23,4 +23,3 @@ instance = DatadogAPIClient::V1::LogsCategoryProcessor.new( type: null ) ``` - diff --git a/docs/v1/LogsCategoryProcessorCategory.md b/docs/v1/LogsCategoryProcessorCategory.md index 5f536c703df3..0f15e9aeeca7 100644 --- a/docs/v1/LogsCategoryProcessorCategory.md +++ b/docs/v1/LogsCategoryProcessorCategory.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **filter** | [**LogsFilter**](LogsFilter.md) | | [optional] | -| **name** | **String** | Value to assign to the target attribute. | [optional] | +| Name | Type | Description | Notes | +| ---------- | ------------------------------- | ---------------------------------------- | ---------- | +| **filter** | [**LogsFilter**](LogsFilter.md) | | [optional] | +| **name** | **String** | Value to assign to the target attribute. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::LogsCategoryProcessorCategory.new( name: null ) ``` - diff --git a/docs/v1/LogsCategoryProcessorType.md b/docs/v1/LogsCategoryProcessorType.md index 932a1193e103..598566128d7c 100644 --- a/docs/v1/LogsCategoryProcessorType.md +++ b/docs/v1/LogsCategoryProcessorType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::LogsCategoryProcessorType.new() ``` - diff --git a/docs/v1/LogsDateRemapper.md b/docs/v1/LogsDateRemapper.md index 672e8ba6a561..985729cbeef5 100644 --- a/docs/v1/LogsDateRemapper.md +++ b/docs/v1/LogsDateRemapper.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **is_enabled** | **Boolean** | Whether or not the processor is enabled. | [optional][default to false] | -| **name** | **String** | Name of the processor. | [optional] | -| **sources** | **Array<String>** | Array of source attributes. | | -| **type** | [**LogsDateRemapperType**](LogsDateRemapperType.md) | | [default to 'date-remapper'] | +| Name | Type | Description | Notes | +| -------------- | --------------------------------------------------- | ---------------------------------------- | ------------------------------------ | +| **is_enabled** | **Boolean** | Whether or not the processor is enabled. | [optional][default to false] | +| **name** | **String** | Name of the processor. | [optional] | +| **sources** | **Array<String>** | Array of source attributes. | | +| **type** | [**LogsDateRemapperType**](LogsDateRemapperType.md) | | [default to 'date-remapper'] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V1::LogsDateRemapper.new( type: null ) ``` - diff --git a/docs/v1/LogsDateRemapperType.md b/docs/v1/LogsDateRemapperType.md index 996b6b641eb7..f1248ccb2d64 100644 --- a/docs/v1/LogsDateRemapperType.md +++ b/docs/v1/LogsDateRemapperType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::LogsDateRemapperType.new() ``` - diff --git a/docs/v1/LogsExclusion.md b/docs/v1/LogsExclusion.md index debb87a076ee..8d03a688eec7 100644 --- a/docs/v1/LogsExclusion.md +++ b/docs/v1/LogsExclusion.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **filter** | [**LogsExclusionFilter**](LogsExclusionFilter.md) | | [optional] | -| **is_enabled** | **Boolean** | Whether or not the exclusion filter is active. | [optional] | -| **name** | **String** | Name of the index exclusion filter. | | +| Name | Type | Description | Notes | +| -------------- | ------------------------------------------------- | ---------------------------------------------- | ---------- | +| **filter** | [**LogsExclusionFilter**](LogsExclusionFilter.md) | | [optional] | +| **is_enabled** | **Boolean** | Whether or not the exclusion filter is active. | [optional] | +| **name** | **String** | Name of the index exclusion filter. | | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::LogsExclusion.new( name: payment ) ``` - diff --git a/docs/v1/LogsExclusionFilter.md b/docs/v1/LogsExclusionFilter.md index effc6a499572..9670af09dd06 100644 --- a/docs/v1/LogsExclusionFilter.md +++ b/docs/v1/LogsExclusionFilter.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **query** | **String** | Default query is `*`, meaning all logs flowing in the index would be excluded. Scope down exclusion filter to only a subset of logs with a log query. | [optional] | -| **sample_rate** | **Float** | Sample rate to apply to logs going through this exclusion filter, a value of 1.0 excludes all logs matching the query. | | +| Name | Type | Description | Notes | +| --------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **query** | **String** | Default query is `\*`, meaning all logs flowing in the index would be excluded. Scope down exclusion filter to only a subset of logs with a log query. | [optional] | +| **sample_rate** | **Float** | Sample rate to apply to logs going through this exclusion filter, a value of 1.0 excludes all logs matching the query. | | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::LogsExclusionFilter.new( sample_rate: 1.0 ) ``` - diff --git a/docs/v1/LogsFilter.md b/docs/v1/LogsFilter.md index 951d9f1b4a52..9ab8c97382cd 100644 --- a/docs/v1/LogsFilter.md +++ b/docs/v1/LogsFilter.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| --------- | ---------- | ----------------- | ---------- | | **query** | **String** | The filter query. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::LogsFilter.new( query: source:python ) ``` - diff --git a/docs/v1/LogsGeoIPParser.md b/docs/v1/LogsGeoIPParser.md index 832721418f38..3a30d96c9871 100644 --- a/docs/v1/LogsGeoIPParser.md +++ b/docs/v1/LogsGeoIPParser.md @@ -2,13 +2,13 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **is_enabled** | **Boolean** | Whether or not the processor is enabled. | [optional][default to false] | -| **name** | **String** | Name of the processor. | [optional] | -| **sources** | **Array<String>** | Array of source attributes. | | -| **target** | **String** | Name of the parent attribute that contains all the extracted details from the `sources`. | [default to 'network.client.geoip'] | -| **type** | [**LogsGeoIPParserType**](LogsGeoIPParserType.md) | | [default to 'geo-ip-parser'] | +| Name | Type | Description | Notes | +| -------------- | ------------------------------------------------- | -------------------------------------------------------------------------------------------------- | ------------------------------------------- | +| **is_enabled** | **Boolean** | Whether or not the processor is enabled. | [optional][default to false] | +| **name** | **String** | Name of the processor. | [optional] | +| **sources** | **Array<String>** | Array of source attributes. | | +| **target** | **String** | Name of the parent attribute that contains all the extracted details from the `sources`. | [default to 'network.client.geoip'] | +| **type** | [**LogsGeoIPParserType**](LogsGeoIPParserType.md) | | [default to 'geo-ip-parser'] | ## Example @@ -23,4 +23,3 @@ instance = DatadogAPIClient::V1::LogsGeoIPParser.new( type: null ) ``` - diff --git a/docs/v1/LogsGeoIPParserType.md b/docs/v1/LogsGeoIPParserType.md index 37be9d8e67b9..33505f93aff1 100644 --- a/docs/v1/LogsGeoIPParserType.md +++ b/docs/v1/LogsGeoIPParserType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::LogsGeoIPParserType.new() ``` - diff --git a/docs/v1/LogsGrokParser.md b/docs/v1/LogsGrokParser.md index f10ae163d225..154ee8b5b862 100644 --- a/docs/v1/LogsGrokParser.md +++ b/docs/v1/LogsGrokParser.md @@ -2,14 +2,14 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **grok** | [**LogsGrokParserRules**](LogsGrokParserRules.md) | | | -| **is_enabled** | **Boolean** | Whether or not the processor is enabled. | [optional][default to false] | -| **name** | **String** | Name of the processor. | [optional] | -| **samples** | **Array<String>** | List of sample logs to test this grok parser. | [optional] | -| **source** | **String** | Name of the log attribute to parse. | [default to 'message'] | -| **type** | [**LogsGrokParserType**](LogsGrokParserType.md) | | [default to 'grok-parser'] | +| Name | Type | Description | Notes | +| -------------- | ------------------------------------------------- | --------------------------------------------- | ---------------------------------- | +| **grok** | [**LogsGrokParserRules**](LogsGrokParserRules.md) | | | +| **is_enabled** | **Boolean** | Whether or not the processor is enabled. | [optional][default to false] | +| **name** | **String** | Name of the processor. | [optional] | +| **samples** | **Array<String>** | List of sample logs to test this grok parser. | [optional] | +| **source** | **String** | Name of the log attribute to parse. | [default to 'message'] | +| **type** | [**LogsGrokParserType**](LogsGrokParserType.md) | | [default to 'grok-parser'] | ## Example @@ -25,4 +25,3 @@ instance = DatadogAPIClient::V1::LogsGrokParser.new( type: null ) ``` - diff --git a/docs/v1/LogsGrokParserRules.md b/docs/v1/LogsGrokParserRules.md index bd72adb0209f..34b9fdbf8fb8 100644 --- a/docs/v1/LogsGrokParserRules.md +++ b/docs/v1/LogsGrokParserRules.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **match_rules** | **String** | List of match rules for the grok parser, separated by a new line. | | +| Name | Type | Description | Notes | +| ----------------- | ---------- | ------------------------------------------------------------------- | --------------------------------- | +| **match_rules** | **String** | List of match rules for the grok parser, separated by a new line. | | | **support_rules** | **String** | List of support rules for the grok parser, separated by a new line. | [optional][default to ''] | ## Example @@ -21,4 +21,3 @@ rule_name_2 bar ) ``` - diff --git a/docs/v1/LogsGrokParserType.md b/docs/v1/LogsGrokParserType.md index 128f40a708cc..001ab4229d84 100644 --- a/docs/v1/LogsGrokParserType.md +++ b/docs/v1/LogsGrokParserType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::LogsGrokParserType.new() ``` - diff --git a/docs/v1/LogsIndex.md b/docs/v1/LogsIndex.md index 33f154ada52c..003ccafe041e 100644 --- a/docs/v1/LogsIndex.md +++ b/docs/v1/LogsIndex.md @@ -2,14 +2,14 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **daily_limit** | **Integer** | The number of log events you can send in this index per day before you are rate-limited. | [optional] | -| **exclusion_filters** | [**Array<LogsExclusion>**](LogsExclusion.md) | An array of exclusion objects. The logs are tested against the query of each filter, following the order of the array. Only the first matching active exclusion matters, others (if any) are ignored. | [optional] | -| **filter** | [**LogsFilter**](LogsFilter.md) | | | -| **is_rate_limited** | **Boolean** | A boolean stating if the index is rate limited, meaning more logs than the daily limit have been sent. Rate limit is reset every-day at 2pm UTC. | [optional][readonly] | -| **name** | **String** | The name of the index. | | -| **num_retention_days** | **Integer** | The number of days before logs are deleted from this index. Available values depend on retention plans specified in your organization's contract/subscriptions. | [optional] | +| Name | Type | Description | Notes | +| ---------------------- | -------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- | +| **daily_limit** | **Integer** | The number of log events you can send in this index per day before you are rate-limited. | [optional] | +| **exclusion_filters** | [**Array<LogsExclusion>**](LogsExclusion.md) | An array of exclusion objects. The logs are tested against the query of each filter, following the order of the array. Only the first matching active exclusion matters, others (if any) are ignored. | [optional] | +| **filter** | [**LogsFilter**](LogsFilter.md) | | | +| **is_rate_limited** | **Boolean** | A boolean stating if the index is rate limited, meaning more logs than the daily limit have been sent. Rate limit is reset every-day at 2pm UTC. | [optional][readonly] | +| **name** | **String** | The name of the index. | | +| **num_retention_days** | **Integer** | The number of days before logs are deleted from this index. Available values depend on retention plans specified in your organization's contract/subscriptions. | [optional] | ## Example @@ -25,4 +25,3 @@ instance = DatadogAPIClient::V1::LogsIndex.new( num_retention_days: 15 ) ``` - diff --git a/docs/v1/LogsIndexListResponse.md b/docs/v1/LogsIndexListResponse.md index e0c31f47a4f1..d011802efbec 100644 --- a/docs/v1/LogsIndexListResponse.md +++ b/docs/v1/LogsIndexListResponse.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| ----------- | ------------------------------------------ | ---------------------------------- | ---------- | | **indexes** | [**Array<LogsIndex>**](LogsIndex.md) | Array of Log index configurations. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::LogsIndexListResponse.new( indexes: null ) ``` - diff --git a/docs/v1/LogsIndexUpdateRequest.md b/docs/v1/LogsIndexUpdateRequest.md index 605a5cb208d2..1873e77a811a 100644 --- a/docs/v1/LogsIndexUpdateRequest.md +++ b/docs/v1/LogsIndexUpdateRequest.md @@ -2,13 +2,13 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **daily_limit** | **Integer** | The number of log events you can send in this index per day before you are rate-limited. | [optional] | -| **disable_daily_limit** | **Boolean** | If true, sets the `daily_limit` value to null and the index is not limited on a daily basis (any specified `daily_limit` value in the request is ignored). If false or omitted, the index's current `daily_limit` is maintained. | [optional] | -| **exclusion_filters** | [**Array<LogsExclusion>**](LogsExclusion.md) | An array of exclusion objects. The logs are tested against the query of each filter, following the order of the array. Only the first matching active exclusion matters, others (if any) are ignored. | [optional] | -| **filter** | [**LogsFilter**](LogsFilter.md) | | | -| **num_retention_days** | **Integer** | The number of days before logs are deleted from this index. Available values depend on retention plans specified in your organization's contract/subscriptions. **Note:** Changing the retention for an index adjusts the length of retention for all logs already in this index. It may also affect billing. | [optional] | +| Name | Type | Description | Notes | +| ----------------------- | -------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **daily_limit** | **Integer** | The number of log events you can send in this index per day before you are rate-limited. | [optional] | +| **disable_daily_limit** | **Boolean** | If true, sets the `daily_limit` value to null and the index is not limited on a daily basis (any specified `daily_limit` value in the request is ignored). If false or omitted, the index's current `daily_limit` is maintained. | [optional] | +| **exclusion_filters** | [**Array<LogsExclusion>**](LogsExclusion.md) | An array of exclusion objects. The logs are tested against the query of each filter, following the order of the array. Only the first matching active exclusion matters, others (if any) are ignored. | [optional] | +| **filter** | [**LogsFilter**](LogsFilter.md) | | | +| **num_retention_days** | **Integer** | The number of days before logs are deleted from this index. Available values depend on retention plans specified in your organization's contract/subscriptions. **Note:** Changing the retention for an index adjusts the length of retention for all logs already in this index. It may also affect billing. | [optional] | ## Example @@ -23,4 +23,3 @@ instance = DatadogAPIClient::V1::LogsIndexUpdateRequest.new( num_retention_days: null ) ``` - diff --git a/docs/v1/LogsIndexesAPI.md b/docs/v1/LogsIndexesAPI.md index 0c9d7ac2eaa7..f94c6220fbde 100644 --- a/docs/v1/LogsIndexesAPI.md +++ b/docs/v1/LogsIndexesAPI.md @@ -2,15 +2,14 @@ All URIs are relative to *https://api.datadoghq.com* -| Method | HTTP request | Description | -| ------ | ------------ | ----------- | -| [**create_logs_index**](LogsIndexesAPI.md#create_logs_index) | **POST** /api/v1/logs/config/indexes | Create an index | -| [**get_logs_index**](LogsIndexesAPI.md#get_logs_index) | **GET** /api/v1/logs/config/indexes/{name} | Get an index | -| [**get_logs_index_order**](LogsIndexesAPI.md#get_logs_index_order) | **GET** /api/v1/logs/config/index-order | Get indexes order | -| [**list_log_indexes**](LogsIndexesAPI.md#list_log_indexes) | **GET** /api/v1/logs/config/indexes | Get all indexes | -| [**update_logs_index**](LogsIndexesAPI.md#update_logs_index) | **PUT** /api/v1/logs/config/indexes/{name} | Update an index | -| [**update_logs_index_order**](LogsIndexesAPI.md#update_logs_index_order) | **PUT** /api/v1/logs/config/index-order | Update indexes order | - +| Method | HTTP request | Description | +| ------------------------------------------------------------------------ | ------------------------------------------ | -------------------- | +| [**create_logs_index**](LogsIndexesAPI.md#create_logs_index) | **POST** /api/v1/logs/config/indexes | Create an index | +| [**get_logs_index**](LogsIndexesAPI.md#get_logs_index) | **GET** /api/v1/logs/config/indexes/{name} | Get an index | +| [**get_logs_index_order**](LogsIndexesAPI.md#get_logs_index_order) | **GET** /api/v1/logs/config/index-order | Get indexes order | +| [**list_log_indexes**](LogsIndexesAPI.md#list_log_indexes) | **GET** /api/v1/logs/config/indexes | Get all indexes | +| [**update_logs_index**](LogsIndexesAPI.md#update_logs_index) | **PUT** /api/v1/logs/config/indexes/{name} | Update an index | +| [**update_logs_index_order**](LogsIndexesAPI.md#update_logs_index_order) | **PUT** /api/v1/logs/config/index-order | Update indexes order | ## create_logs_index @@ -54,9 +53,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**LogsIndex**](LogsIndex.md) | Object containing the new index. | | +| Name | Type | Description | Notes | +| -------- | ----------------------------- | -------------------------------- | ----- | +| **body** | [**LogsIndex**](LogsIndex.md) | Object containing the new index. | | ### Return type @@ -71,7 +70,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## get_logs_index > get_logs_index(name) @@ -114,9 +112,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **name** | **String** | Name of the log index. | | +| Name | Type | Description | Notes | +| -------- | ---------- | ---------------------- | ----- | +| **name** | **String** | Name of the log index. | | ### Return type @@ -131,7 +129,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## get_logs_index_order > get_logs_index_order @@ -188,7 +185,6 @@ This endpoint does not need any parameter. - **Content-Type**: Not defined - **Accept**: application/json - ## list_log_indexes > list_log_indexes @@ -246,7 +242,6 @@ This endpoint does not need any parameter. - **Content-Type**: Not defined - **Accept**: application/json - ## update_logs_index > update_logs_index(name, body) @@ -294,10 +289,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **name** | **String** | Name of the log index. | | -| **body** | [**LogsIndexUpdateRequest**](LogsIndexUpdateRequest.md) | Object containing the new `LogsIndexUpdateRequest`. | | +| Name | Type | Description | Notes | +| -------- | ------------------------------------------------------- | ------------------------------------------------------------- | ----- | +| **name** | **String** | Name of the log index. | | +| **body** | [**LogsIndexUpdateRequest**](LogsIndexUpdateRequest.md) | Object containing the new `LogsIndexUpdateRequest`. | | ### Return type @@ -312,7 +307,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## update_logs_index_order > update_logs_index_order(body) @@ -356,9 +350,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**LogsIndexesOrder**](LogsIndexesOrder.md) | Object containing the new ordered list of index names | | +| Name | Type | Description | Notes | +| -------- | ------------------------------------------- | ----------------------------------------------------- | ----- | +| **body** | [**LogsIndexesOrder**](LogsIndexesOrder.md) | Object containing the new ordered list of index names | | ### Return type @@ -372,4 +366,3 @@ end - **Content-Type**: application/json - **Accept**: application/json - diff --git a/docs/v1/LogsIndexesOrder.md b/docs/v1/LogsIndexesOrder.md index c8c60953fdcf..7c8eea4d533a 100644 --- a/docs/v1/LogsIndexesOrder.md +++ b/docs/v1/LogsIndexesOrder.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **index_names** | **Array<String>** | Array of strings identifying by their name(s) the index(es) of your organization. Logs are tested against the query filter of each index one by one, following the order of the array. Logs are eventually stored in the first matching index. | | +| Name | Type | Description | Notes | +| --------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- | +| **index_names** | **Array<String>** | Array of strings identifying by their name(s) the index(es) of your organization. Logs are tested against the query filter of each index one by one, following the order of the array. Logs are eventually stored in the first matching index. | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::LogsIndexesOrder.new( index_names: ["main","payments","web"] ) ``` - diff --git a/docs/v1/LogsListRequest.md b/docs/v1/LogsListRequest.md index de2c78544908..76bf708f268a 100644 --- a/docs/v1/LogsListRequest.md +++ b/docs/v1/LogsListRequest.md @@ -2,14 +2,14 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **index** | **String** | The log index on which the request is performed. For multi-index organizations, the default is all live indexes. Historical indexes of rehydrated logs must be specified. | [optional] | -| **limit** | **Integer** | Number of logs return in the response. | [optional] | -| **query** | **String** | The search query - following the log search syntax. | [optional] | -| **sort** | [**LogsSort**](LogsSort.md) | | [optional] | -| **start_at** | **String** | Hash identifier of the first log to return in the list, available in a log `id` attribute. This parameter is used for the pagination feature. **Note**: This parameter is ignored if the corresponding log is out of the scope of the specified time window. | [optional] | -| **time** | [**LogsListRequestTime**](LogsListRequestTime.md) | | | +| Name | Type | Description | Notes | +| ------------ | ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **index** | **String** | The log index on which the request is performed. For multi-index organizations, the default is all live indexes. Historical indexes of rehydrated logs must be specified. | [optional] | +| **limit** | **Integer** | Number of logs return in the response. | [optional] | +| **query** | **String** | The search query - following the log search syntax. | [optional] | +| **sort** | [**LogsSort**](LogsSort.md) | | [optional] | +| **start_at** | **String** | Hash identifier of the first log to return in the list, available in a log `id` attribute. This parameter is used for the pagination feature. **Note**: This parameter is ignored if the corresponding log is out of the scope of the specified time window. | [optional] | +| **time** | [**LogsListRequestTime**](LogsListRequestTime.md) | | | ## Example @@ -25,4 +25,3 @@ instance = DatadogAPIClient::V1::LogsListRequest.new( time: null ) ``` - diff --git a/docs/v1/LogsListRequestTime.md b/docs/v1/LogsListRequestTime.md index 6be206f04e30..9afe38366559 100644 --- a/docs/v1/LogsListRequestTime.md +++ b/docs/v1/LogsListRequestTime.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **from** | **Time** | Minimum timestamp for requested logs. | | +| Name | Type | Description | Notes | +| ------------ | ---------- | -------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **from** | **Time** | Minimum timestamp for requested logs. | | | **timezone** | **String** | Timezone can be specified both as an offset (e.g. \"UTC+03:00\") or a regional zone (e.g. \"Europe/Paris\"). | [optional] | -| **to** | **Time** | Maximum timestamp for requested logs. | | +| **to** | **Time** | Maximum timestamp for requested logs. | | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::LogsListRequestTime.new( to: 2020-02-02T20:20:20Z ) ``` - diff --git a/docs/v1/LogsListResponse.md b/docs/v1/LogsListResponse.md index b577da805b71..c5397ce39648 100644 --- a/docs/v1/LogsListResponse.md +++ b/docs/v1/LogsListResponse.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **logs** | [**Array<Log>**](Log.md) | Array of logs matching the request and the `nextLogId` if sent. | [optional] | -| **next_log_id** | **String** | Hash identifier of the next log to return in the list. This parameter is used for the pagination feature. | [optional] | -| **status** | **String** | Status of the response. | [optional] | +| Name | Type | Description | Notes | +| --------------- | ------------------------------ | --------------------------------------------------------------------------------------------------------- | ---------- | +| **logs** | [**Array<Log>**](Log.md) | Array of logs matching the request and the `nextLogId` if sent. | [optional] | +| **next_log_id** | **String** | Hash identifier of the next log to return in the list. This parameter is used for the pagination feature. | [optional] | +| **status** | **String** | Status of the response. | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::LogsListResponse.new( status: null ) ``` - diff --git a/docs/v1/LogsLookupProcessor.md b/docs/v1/LogsLookupProcessor.md index 0605a07f7d38..5784dd411eaa 100644 --- a/docs/v1/LogsLookupProcessor.md +++ b/docs/v1/LogsLookupProcessor.md @@ -2,15 +2,15 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **default_lookup** | **String** | Value to set the target attribute if the source value is not found in the list. | [optional] | -| **is_enabled** | **Boolean** | Whether or not the processor is enabled. | [optional][default to false] | -| **lookup_table** | **Array<String>** | Mapping table of values for the source attribute and their associated target attribute values, formatted as `[\"source_key1,target_value1\", \"source_key2,target_value2\"]` | | -| **name** | **String** | Name of the processor. | [optional] | -| **source** | **String** | Source attribute used to perform the lookup. | | -| **target** | **String** | Name of the attribute that contains the corresponding value in the mapping list or the `default_lookup` if not found in the mapping list. | | -| **type** | [**LogsLookupProcessorType**](LogsLookupProcessorType.md) | | [default to 'lookup-processor'] | +| Name | Type | Description | Notes | +| ------------------ | --------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- | +| **default_lookup** | **String** | Value to set the target attribute if the source value is not found in the list. | [optional] | +| **is_enabled** | **Boolean** | Whether or not the processor is enabled. | [optional][default to false] | +| **lookup_table** | **Array<String>** | Mapping table of values for the source attribute and their associated target attribute values, formatted as `[\"source_key1,target_value1\", \"source_key2,target_value2\"]` | | +| **name** | **String** | Name of the processor. | [optional] | +| **source** | **String** | Source attribute used to perform the lookup. | | +| **target** | **String** | Name of the attribute that contains the corresponding value in the mapping list or the `default_lookup` if not found in the mapping list. | | +| **type** | [**LogsLookupProcessorType**](LogsLookupProcessorType.md) | | [default to 'lookup-processor'] | ## Example @@ -27,4 +27,3 @@ instance = DatadogAPIClient::V1::LogsLookupProcessor.new( type: null ) ``` - diff --git a/docs/v1/LogsLookupProcessorType.md b/docs/v1/LogsLookupProcessorType.md index 8df38a924a21..125d4d6a2f8d 100644 --- a/docs/v1/LogsLookupProcessorType.md +++ b/docs/v1/LogsLookupProcessorType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::LogsLookupProcessorType.new() ``` - diff --git a/docs/v1/LogsMessageRemapper.md b/docs/v1/LogsMessageRemapper.md index 6e9cb5d85118..2a774973a782 100644 --- a/docs/v1/LogsMessageRemapper.md +++ b/docs/v1/LogsMessageRemapper.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **is_enabled** | **Boolean** | Whether or not the processor is enabled. | [optional][default to false] | -| **name** | **String** | Name of the processor. | [optional] | -| **sources** | **Array<String>** | Array of source attributes. | | -| **type** | [**LogsMessageRemapperType**](LogsMessageRemapperType.md) | | [default to 'message-remapper'] | +| Name | Type | Description | Notes | +| -------------- | --------------------------------------------------------- | ---------------------------------------- | --------------------------------------- | +| **is_enabled** | **Boolean** | Whether or not the processor is enabled. | [optional][default to false] | +| **name** | **String** | Name of the processor. | [optional] | +| **sources** | **Array<String>** | Array of source attributes. | | +| **type** | [**LogsMessageRemapperType**](LogsMessageRemapperType.md) | | [default to 'message-remapper'] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V1::LogsMessageRemapper.new( type: null ) ``` - diff --git a/docs/v1/LogsMessageRemapperType.md b/docs/v1/LogsMessageRemapperType.md index 47678e389f7c..84e7a574898c 100644 --- a/docs/v1/LogsMessageRemapperType.md +++ b/docs/v1/LogsMessageRemapperType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::LogsMessageRemapperType.new() ``` - diff --git a/docs/v1/LogsPipeline.md b/docs/v1/LogsPipeline.md index 45ca87c356db..d6ca0f8dee5f 100644 --- a/docs/v1/LogsPipeline.md +++ b/docs/v1/LogsPipeline.md @@ -2,15 +2,15 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **filter** | [**LogsFilter**](LogsFilter.md) | | [optional] | -| **id** | **String** | ID of the pipeline. | [optional][readonly] | -| **is_enabled** | **Boolean** | Whether or not the pipeline is enabled. | [optional] | -| **is_read_only** | **Boolean** | Whether or not the pipeline can be edited. | [optional][readonly] | -| **name** | **String** | Name of the pipeline. | | -| **processors** | [**Array<LogsProcessor>**](LogsProcessor.md) | Ordered list of processors in this pipeline. | [optional] | -| **type** | **String** | Type of pipeline. | [optional][readonly] | +| Name | Type | Description | Notes | +| ---------------- | -------------------------------------------------- | -------------------------------------------- | -------------------- | +| **filter** | [**LogsFilter**](LogsFilter.md) | | [optional] | +| **id** | **String** | ID of the pipeline. | [optional][readonly] | +| **is_enabled** | **Boolean** | Whether or not the pipeline is enabled. | [optional] | +| **is_read_only** | **Boolean** | Whether or not the pipeline can be edited. | [optional][readonly] | +| **name** | **String** | Name of the pipeline. | | +| **processors** | [**Array<LogsProcessor>**](LogsProcessor.md) | Ordered list of processors in this pipeline. | [optional] | +| **type** | **String** | Type of pipeline. | [optional][readonly] | ## Example @@ -27,4 +27,3 @@ instance = DatadogAPIClient::V1::LogsPipeline.new( type: pipeline ) ``` - diff --git a/docs/v1/LogsPipelineProcessor.md b/docs/v1/LogsPipelineProcessor.md index 2a339dc95f97..745dc11c71b9 100644 --- a/docs/v1/LogsPipelineProcessor.md +++ b/docs/v1/LogsPipelineProcessor.md @@ -2,13 +2,13 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **filter** | [**LogsFilter**](LogsFilter.md) | | [optional] | -| **is_enabled** | **Boolean** | Whether or not the processor is enabled. | [optional][default to false] | -| **name** | **String** | Name of the processor. | [optional] | -| **processors** | [**Array<LogsProcessor>**](LogsProcessor.md) | Ordered list of processors in this pipeline. | [optional] | -| **type** | [**LogsPipelineProcessorType**](LogsPipelineProcessorType.md) | | [default to 'pipeline'] | +| Name | Type | Description | Notes | +| -------------- | ------------------------------------------------------------- | -------------------------------------------- | ------------------------------- | +| **filter** | [**LogsFilter**](LogsFilter.md) | | [optional] | +| **is_enabled** | **Boolean** | Whether or not the processor is enabled. | [optional][default to false] | +| **name** | **String** | Name of the processor. | [optional] | +| **processors** | [**Array<LogsProcessor>**](LogsProcessor.md) | Ordered list of processors in this pipeline. | [optional] | +| **type** | [**LogsPipelineProcessorType**](LogsPipelineProcessorType.md) | | [default to 'pipeline'] | ## Example @@ -23,4 +23,3 @@ instance = DatadogAPIClient::V1::LogsPipelineProcessor.new( type: null ) ``` - diff --git a/docs/v1/LogsPipelineProcessorType.md b/docs/v1/LogsPipelineProcessorType.md index 33996a5647bb..34238beca282 100644 --- a/docs/v1/LogsPipelineProcessorType.md +++ b/docs/v1/LogsPipelineProcessorType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::LogsPipelineProcessorType.new() ``` - diff --git a/docs/v1/LogsPipelinesAPI.md b/docs/v1/LogsPipelinesAPI.md index d33180360eb3..b81ce859365f 100644 --- a/docs/v1/LogsPipelinesAPI.md +++ b/docs/v1/LogsPipelinesAPI.md @@ -2,16 +2,15 @@ All URIs are relative to *https://api.datadoghq.com* -| Method | HTTP request | Description | -| ------ | ------------ | ----------- | -| [**create_logs_pipeline**](LogsPipelinesAPI.md#create_logs_pipeline) | **POST** /api/v1/logs/config/pipelines | Create a pipeline | -| [**delete_logs_pipeline**](LogsPipelinesAPI.md#delete_logs_pipeline) | **DELETE** /api/v1/logs/config/pipelines/{pipeline_id} | Delete a pipeline | -| [**get_logs_pipeline**](LogsPipelinesAPI.md#get_logs_pipeline) | **GET** /api/v1/logs/config/pipelines/{pipeline_id} | Get a pipeline | -| [**get_logs_pipeline_order**](LogsPipelinesAPI.md#get_logs_pipeline_order) | **GET** /api/v1/logs/config/pipeline-order | Get pipeline order | -| [**list_logs_pipelines**](LogsPipelinesAPI.md#list_logs_pipelines) | **GET** /api/v1/logs/config/pipelines | Get all pipelines | -| [**update_logs_pipeline**](LogsPipelinesAPI.md#update_logs_pipeline) | **PUT** /api/v1/logs/config/pipelines/{pipeline_id} | Update a pipeline | -| [**update_logs_pipeline_order**](LogsPipelinesAPI.md#update_logs_pipeline_order) | **PUT** /api/v1/logs/config/pipeline-order | Update pipeline order | - +| Method | HTTP request | Description | +| -------------------------------------------------------------------------------- | ------------------------------------------------------ | --------------------- | +| [**create_logs_pipeline**](LogsPipelinesAPI.md#create_logs_pipeline) | **POST** /api/v1/logs/config/pipelines | Create a pipeline | +| [**delete_logs_pipeline**](LogsPipelinesAPI.md#delete_logs_pipeline) | **DELETE** /api/v1/logs/config/pipelines/{pipeline_id} | Delete a pipeline | +| [**get_logs_pipeline**](LogsPipelinesAPI.md#get_logs_pipeline) | **GET** /api/v1/logs/config/pipelines/{pipeline_id} | Get a pipeline | +| [**get_logs_pipeline_order**](LogsPipelinesAPI.md#get_logs_pipeline_order) | **GET** /api/v1/logs/config/pipeline-order | Get pipeline order | +| [**list_logs_pipelines**](LogsPipelinesAPI.md#list_logs_pipelines) | **GET** /api/v1/logs/config/pipelines | Get all pipelines | +| [**update_logs_pipeline**](LogsPipelinesAPI.md#update_logs_pipeline) | **PUT** /api/v1/logs/config/pipelines/{pipeline_id} | Update a pipeline | +| [**update_logs_pipeline_order**](LogsPipelinesAPI.md#update_logs_pipeline_order) | **PUT** /api/v1/logs/config/pipeline-order | Update pipeline order | ## create_logs_pipeline @@ -55,9 +54,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**LogsPipeline**](LogsPipeline.md) | Definition of the new pipeline. | | +| Name | Type | Description | Notes | +| -------- | ----------------------------------- | ------------------------------- | ----- | +| **body** | [**LogsPipeline**](LogsPipeline.md) | Definition of the new pipeline. | | ### Return type @@ -72,7 +71,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## delete_logs_pipeline > delete_logs_pipeline(pipeline_id) @@ -115,9 +113,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **pipeline_id** | **String** | ID of the pipeline to delete. | | +| Name | Type | Description | Notes | +| --------------- | ---------- | ----------------------------- | ----- | +| **pipeline_id** | **String** | ID of the pipeline to delete. | | ### Return type @@ -132,7 +130,6 @@ nil (empty response body) - **Content-Type**: Not defined - **Accept**: application/json - ## get_logs_pipeline > get_logs_pipeline(pipeline_id) @@ -176,9 +173,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **pipeline_id** | **String** | ID of the pipeline to get. | | +| Name | Type | Description | Notes | +| --------------- | ---------- | -------------------------- | ----- | +| **pipeline_id** | **String** | ID of the pipeline to get. | | ### Return type @@ -193,7 +190,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## get_logs_pipeline_order > get_logs_pipeline_order @@ -251,7 +247,6 @@ This endpoint does not need any parameter. - **Content-Type**: Not defined - **Accept**: application/json - ## list_logs_pipelines > > list_logs_pipelines @@ -309,7 +304,6 @@ This endpoint does not need any parameter. - **Content-Type**: Not defined - **Accept**: application/json - ## update_logs_pipeline > update_logs_pipeline(pipeline_id, body) @@ -356,10 +350,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **pipeline_id** | **String** | ID of the pipeline to delete. | | -| **body** | [**LogsPipeline**](LogsPipeline.md) | New definition of the pipeline. | | +| Name | Type | Description | Notes | +| --------------- | ----------------------------------- | ------------------------------- | ----- | +| **pipeline_id** | **String** | ID of the pipeline to delete. | | +| **body** | [**LogsPipeline**](LogsPipeline.md) | New definition of the pipeline. | | ### Return type @@ -374,7 +368,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## update_logs_pipeline_order > update_logs_pipeline_order(body) @@ -421,9 +414,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**LogsPipelinesOrder**](LogsPipelinesOrder.md) | Object containing the new ordered list of pipeline IDs. | | +| Name | Type | Description | Notes | +| -------- | ----------------------------------------------- | ------------------------------------------------------- | ----- | +| **body** | [**LogsPipelinesOrder**](LogsPipelinesOrder.md) | Object containing the new ordered list of pipeline IDs. | | ### Return type @@ -437,4 +430,3 @@ end - **Content-Type**: application/json - **Accept**: application/json - diff --git a/docs/v1/LogsPipelinesOrder.md b/docs/v1/LogsPipelinesOrder.md index 306abee96d6b..56132a64970c 100644 --- a/docs/v1/LogsPipelinesOrder.md +++ b/docs/v1/LogsPipelinesOrder.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **pipeline_ids** | **Array<String>** | Ordered Array of `<PIPELINE_ID>` strings, the order of pipeline IDs in the array define the overall Pipelines order for Datadog. | | +| Name | Type | Description | Notes | +| ---------------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ----- | +| **pipeline_ids** | **Array<String>** | Ordered Array of `<PIPELINE_ID>` strings, the order of pipeline IDs in the array define the overall Pipelines order for Datadog. | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::LogsPipelinesOrder.new( pipeline_ids: ["tags","org_ids","products"] ) ``` - diff --git a/docs/v1/LogsProcessor.md b/docs/v1/LogsProcessor.md index f3e171ad29e4..aa6b84b62fa5 100644 --- a/docs/v1/LogsProcessor.md +++ b/docs/v1/LogsProcessor.md @@ -50,8 +50,8 @@ DatadogAPIClient::V1::LogsProcessor.build(data_that_doesnt_match) #### Parameters -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| -------- | --------- | -------------------------------------------------- | | **data** | **Mixed** | data to be matched against the list of oneOf items | #### Return type @@ -72,4 +72,3 @@ DatadogAPIClient::V1::LogsProcessor.build(data_that_doesnt_match) - `LogsURLParser` - `LogsUserAgentParser` - `nil` (if no type matches) - diff --git a/docs/v1/LogsQueryCompute.md b/docs/v1/LogsQueryCompute.md index e9510ec9fa27..b67d45a7a9fc 100644 --- a/docs/v1/LogsQueryCompute.md +++ b/docs/v1/LogsQueryCompute.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **aggregation** | **String** | The aggregation method. | | -| **facet** | **String** | Facet name. | [optional] | -| **interval** | **Integer** | Define a time interval in seconds. | [optional] | +| Name | Type | Description | Notes | +| --------------- | ----------- | ---------------------------------- | ---------- | +| **aggregation** | **String** | The aggregation method. | | +| **facet** | **String** | Facet name. | [optional] | +| **interval** | **Integer** | Define a time interval in seconds. | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::LogsQueryCompute.new( interval: 5000 ) ``` - diff --git a/docs/v1/LogsRetentionAggSumUsage.md b/docs/v1/LogsRetentionAggSumUsage.md index c9b3e391b443..a675dc9c0985 100644 --- a/docs/v1/LogsRetentionAggSumUsage.md +++ b/docs/v1/LogsRetentionAggSumUsage.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **logs_indexed_logs_usage_agg_sum** | **Integer** | Total indexed logs for this retention period. | [optional] | -| **logs_live_indexed_logs_usage_agg_sum** | **Integer** | Live indexed logs for this retention period. | [optional] | -| **logs_rehydrated_indexed_logs_usage_agg_sum** | **Integer** | Rehydrated indexed logs for this retention period. | [optional] | -| **retention** | **String** | The retention period in days or \"custom\" for all custom retention periods. | [optional] | +| Name | Type | Description | Notes | +| ---------------------------------------------- | ----------- | -------------------------------------------------------------------------------------- | ---------- | +| **logs_indexed_logs_usage_agg_sum** | **Integer** | Total indexed logs for this retention period. | [optional] | +| **logs_live_indexed_logs_usage_agg_sum** | **Integer** | Live indexed logs for this retention period. | [optional] | +| **logs_rehydrated_indexed_logs_usage_agg_sum** | **Integer** | Rehydrated indexed logs for this retention period. | [optional] | +| **retention** | **String** | The retention period in days or \"custom\" for all custom retention periods. | [optional] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V1::LogsRetentionAggSumUsage.new( retention: null ) ``` - diff --git a/docs/v1/LogsRetentionSumUsage.md b/docs/v1/LogsRetentionSumUsage.md index ffe3f7289f08..8a756e56df4b 100644 --- a/docs/v1/LogsRetentionSumUsage.md +++ b/docs/v1/LogsRetentionSumUsage.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **logs_indexed_logs_usage_sum** | **Integer** | Total indexed logs for this retention period. | [optional] | -| **logs_live_indexed_logs_usage_sum** | **Integer** | Live indexed logs for this retention period. | [optional] | -| **logs_rehydrated_indexed_logs_usage_sum** | **Integer** | Rehydrated indexed logs for this retention period. | [optional] | -| **retention** | **String** | The retention period in days or \"custom\" for all custom retention periods. | [optional] | +| Name | Type | Description | Notes | +| ------------------------------------------ | ----------- | -------------------------------------------------------------------------------------- | ---------- | +| **logs_indexed_logs_usage_sum** | **Integer** | Total indexed logs for this retention period. | [optional] | +| **logs_live_indexed_logs_usage_sum** | **Integer** | Live indexed logs for this retention period. | [optional] | +| **logs_rehydrated_indexed_logs_usage_sum** | **Integer** | Rehydrated indexed logs for this retention period. | [optional] | +| **retention** | **String** | The retention period in days or \"custom\" for all custom retention periods. | [optional] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V1::LogsRetentionSumUsage.new( retention: null ) ``` - diff --git a/docs/v1/LogsServiceRemapper.md b/docs/v1/LogsServiceRemapper.md index cb76c2f351bf..42a36e569203 100644 --- a/docs/v1/LogsServiceRemapper.md +++ b/docs/v1/LogsServiceRemapper.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **is_enabled** | **Boolean** | Whether or not the processor is enabled. | [optional][default to false] | -| **name** | **String** | Name of the processor. | [optional] | -| **sources** | **Array<String>** | Array of source attributes. | | -| **type** | [**LogsServiceRemapperType**](LogsServiceRemapperType.md) | | [default to 'service-remapper'] | +| Name | Type | Description | Notes | +| -------------- | --------------------------------------------------------- | ---------------------------------------- | --------------------------------------- | +| **is_enabled** | **Boolean** | Whether or not the processor is enabled. | [optional][default to false] | +| **name** | **String** | Name of the processor. | [optional] | +| **sources** | **Array<String>** | Array of source attributes. | | +| **type** | [**LogsServiceRemapperType**](LogsServiceRemapperType.md) | | [default to 'service-remapper'] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V1::LogsServiceRemapper.new( type: null ) ``` - diff --git a/docs/v1/LogsServiceRemapperType.md b/docs/v1/LogsServiceRemapperType.md index 8712ec477b06..817114a051db 100644 --- a/docs/v1/LogsServiceRemapperType.md +++ b/docs/v1/LogsServiceRemapperType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::LogsServiceRemapperType.new() ``` - diff --git a/docs/v1/LogsSort.md b/docs/v1/LogsSort.md index 476604a4c508..52d189d25e3f 100644 --- a/docs/v1/LogsSort.md +++ b/docs/v1/LogsSort.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::LogsSort.new() ``` - diff --git a/docs/v1/LogsStatusRemapper.md b/docs/v1/LogsStatusRemapper.md index 25f60a39e63e..db8974184d00 100644 --- a/docs/v1/LogsStatusRemapper.md +++ b/docs/v1/LogsStatusRemapper.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **is_enabled** | **Boolean** | Whether or not the processor is enabled. | [optional][default to false] | -| **name** | **String** | Name of the processor. | [optional] | -| **sources** | **Array<String>** | Array of source attributes. | | -| **type** | [**LogsStatusRemapperType**](LogsStatusRemapperType.md) | | [default to 'status-remapper'] | +| Name | Type | Description | Notes | +| -------------- | ------------------------------------------------------- | ---------------------------------------- | -------------------------------------- | +| **is_enabled** | **Boolean** | Whether or not the processor is enabled. | [optional][default to false] | +| **name** | **String** | Name of the processor. | [optional] | +| **sources** | **Array<String>** | Array of source attributes. | | +| **type** | [**LogsStatusRemapperType**](LogsStatusRemapperType.md) | | [default to 'status-remapper'] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V1::LogsStatusRemapper.new( type: null ) ``` - diff --git a/docs/v1/LogsStatusRemapperType.md b/docs/v1/LogsStatusRemapperType.md index 65813e7c8102..3d5be815059e 100644 --- a/docs/v1/LogsStatusRemapperType.md +++ b/docs/v1/LogsStatusRemapperType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::LogsStatusRemapperType.new() ``` - diff --git a/docs/v1/LogsStringBuilderProcessor.md b/docs/v1/LogsStringBuilderProcessor.md index c7283569b621..1b74bff80a4d 100644 --- a/docs/v1/LogsStringBuilderProcessor.md +++ b/docs/v1/LogsStringBuilderProcessor.md @@ -2,14 +2,14 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **is_enabled** | **Boolean** | Whether or not the processor is enabled. | [optional][default to false] | -| **is_replace_missing** | **Boolean** | If true, it replaces all missing attributes of `template` by an empty string. If `false` (default), skips the operation for missing attributes. | [optional][default to false] | -| **name** | **String** | Name of the processor. | [optional] | -| **target** | **String** | The name of the attribute that contains the result of the template. | | -| **template** | **String** | A formula with one or more attributes and raw text. | | -| **type** | [**LogsStringBuilderProcessorType**](LogsStringBuilderProcessorType.md) | | [default to 'string-builder-processor'] | +| Name | Type | Description | Notes | +| ---------------------- | ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | +| **is_enabled** | **Boolean** | Whether or not the processor is enabled. | [optional][default to false] | +| **is_replace_missing** | **Boolean** | If true, it replaces all missing attributes of `template` by an empty string. If `false` (default), skips the operation for missing attributes. | [optional][default to false] | +| **name** | **String** | Name of the processor. | [optional] | +| **target** | **String** | The name of the attribute that contains the result of the template. | | +| **template** | **String** | A formula with one or more attributes and raw text. | | +| **type** | [**LogsStringBuilderProcessorType**](LogsStringBuilderProcessorType.md) | | [default to 'string-builder-processor'] | ## Example @@ -25,4 +25,3 @@ instance = DatadogAPIClient::V1::LogsStringBuilderProcessor.new( type: null ) ``` - diff --git a/docs/v1/LogsStringBuilderProcessorType.md b/docs/v1/LogsStringBuilderProcessorType.md index 232f8b55c267..2fb8a1969697 100644 --- a/docs/v1/LogsStringBuilderProcessorType.md +++ b/docs/v1/LogsStringBuilderProcessorType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::LogsStringBuilderProcessorType.new() ``` - diff --git a/docs/v1/LogsTraceRemapper.md b/docs/v1/LogsTraceRemapper.md index fa0b79c608f3..1b6711ea4088 100644 --- a/docs/v1/LogsTraceRemapper.md +++ b/docs/v1/LogsTraceRemapper.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **is_enabled** | **Boolean** | Whether or not the processor is enabled. | [optional][default to false] | -| **name** | **String** | Name of the processor. | [optional] | -| **sources** | **Array<String>** | Array of source attributes. | [optional] | -| **type** | [**LogsTraceRemapperType**](LogsTraceRemapperType.md) | | [default to 'trace-id-remapper'] | +| Name | Type | Description | Notes | +| -------------- | ----------------------------------------------------- | ---------------------------------------- | ---------------------------------------- | +| **is_enabled** | **Boolean** | Whether or not the processor is enabled. | [optional][default to false] | +| **name** | **String** | Name of the processor. | [optional] | +| **sources** | **Array<String>** | Array of source attributes. | [optional] | +| **type** | [**LogsTraceRemapperType**](LogsTraceRemapperType.md) | | [default to 'trace-id-remapper'] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V1::LogsTraceRemapper.new( type: null ) ``` - diff --git a/docs/v1/LogsTraceRemapperType.md b/docs/v1/LogsTraceRemapperType.md index 02d41ca81edb..54a2a04cf6dd 100644 --- a/docs/v1/LogsTraceRemapperType.md +++ b/docs/v1/LogsTraceRemapperType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::LogsTraceRemapperType.new() ``` - diff --git a/docs/v1/LogsURLParser.md b/docs/v1/LogsURLParser.md index 8b3b5572fef1..4ebe483a888c 100644 --- a/docs/v1/LogsURLParser.md +++ b/docs/v1/LogsURLParser.md @@ -2,14 +2,14 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **is_enabled** | **Boolean** | Whether or not the processor is enabled. | [optional][default to false] | -| **name** | **String** | Name of the processor. | [optional] | -| **normalize_ending_slashes** | **Boolean** | Normalize the ending slashes or not. | [optional][default to false] | -| **sources** | **Array<String>** | Array of source attributes. | | -| **target** | **String** | Name of the parent attribute that contains all the extracted details from the `sources`. | [default to 'http.url_details'] | -| **type** | [**LogsURLParserType**](LogsURLParserType.md) | | [default to 'url-parser'] | +| Name | Type | Description | Notes | +| ---------------------------- | --------------------------------------------- | -------------------------------------------------------------------------------------------------- | --------------------------------------- | +| **is_enabled** | **Boolean** | Whether or not the processor is enabled. | [optional][default to false] | +| **name** | **String** | Name of the processor. | [optional] | +| **normalize_ending_slashes** | **Boolean** | Normalize the ending slashes or not. | [optional][default to false] | +| **sources** | **Array<String>** | Array of source attributes. | | +| **target** | **String** | Name of the parent attribute that contains all the extracted details from the `sources`. | [default to 'http.url_details'] | +| **type** | [**LogsURLParserType**](LogsURLParserType.md) | | [default to 'url-parser'] | ## Example @@ -25,4 +25,3 @@ instance = DatadogAPIClient::V1::LogsURLParser.new( type: null ) ``` - diff --git a/docs/v1/LogsURLParserType.md b/docs/v1/LogsURLParserType.md index 881f3964486b..f197c1cfa033 100644 --- a/docs/v1/LogsURLParserType.md +++ b/docs/v1/LogsURLParserType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::LogsURLParserType.new() ``` - diff --git a/docs/v1/LogsUserAgentParser.md b/docs/v1/LogsUserAgentParser.md index 076b1ce6529c..081f9a17c2da 100644 --- a/docs/v1/LogsUserAgentParser.md +++ b/docs/v1/LogsUserAgentParser.md @@ -2,14 +2,14 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **is_enabled** | **Boolean** | Whether or not the processor is enabled. | [optional][default to false] | -| **is_encoded** | **Boolean** | Define if the source attribute is URL encoded or not. | [optional][default to false] | -| **name** | **String** | Name of the processor. | [optional] | -| **sources** | **Array<String>** | Array of source attributes. | | -| **target** | **String** | Name of the parent attribute that contains all the extracted details from the `sources`. | [default to 'http.useragent_details'] | -| **type** | [**LogsUserAgentParserType**](LogsUserAgentParserType.md) | | [default to 'user-agent-parser'] | +| Name | Type | Description | Notes | +| -------------- | --------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | --------------------------------------------- | +| **is_enabled** | **Boolean** | Whether or not the processor is enabled. | [optional][default to false] | +| **is_encoded** | **Boolean** | Define if the source attribute is URL encoded or not. | [optional][default to false] | +| **name** | **String** | Name of the processor. | [optional] | +| **sources** | **Array<String>** | Array of source attributes. | | +| **target** | **String** | Name of the parent attribute that contains all the extracted details from the `sources`. | [default to 'http.useragent_details'] | +| **type** | [**LogsUserAgentParserType**](LogsUserAgentParserType.md) | | [default to 'user-agent-parser'] | ## Example @@ -25,4 +25,3 @@ instance = DatadogAPIClient::V1::LogsUserAgentParser.new( type: null ) ``` - diff --git a/docs/v1/LogsUserAgentParserType.md b/docs/v1/LogsUserAgentParserType.md index 4029dde0ccc6..267516f06b89 100644 --- a/docs/v1/LogsUserAgentParserType.md +++ b/docs/v1/LogsUserAgentParserType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::LogsUserAgentParserType.new() ``` - diff --git a/docs/v1/MetricContentEncoding.md b/docs/v1/MetricContentEncoding.md index 1aeef5bafafc..60744d7f0cb3 100644 --- a/docs/v1/MetricContentEncoding.md +++ b/docs/v1/MetricContentEncoding.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::MetricContentEncoding.new() ``` - diff --git a/docs/v1/MetricMetadata.md b/docs/v1/MetricMetadata.md index 8712d2c5fa74..ecf66808bdb4 100644 --- a/docs/v1/MetricMetadata.md +++ b/docs/v1/MetricMetadata.md @@ -2,15 +2,15 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **description** | **String** | Metric description. | [optional] | -| **integration** | **String** | Name of the integration that sent the metric if applicable. | [optional][readonly] | -| **per_unit** | **String** | Per unit of the metric such as `second` in `bytes per second`. | [optional] | -| **short_name** | **String** | A more human-readable and abbreviated version of the metric name. | [optional] | -| **statsd_interval** | **Integer** | StatsD flush interval of the metric in seconds if applicable. | [optional] | -| **type** | **String** | Metric type such as `gauge` or `rate`. | [optional] | -| **unit** | **String** | Primary unit of the metric such as `byte` or `operation`. | [optional] | +| Name | Type | Description | Notes | +| ------------------- | ----------- | ---------------------------------------------------------------------------------- | -------------------- | +| **description** | **String** | Metric description. | [optional] | +| **integration** | **String** | Name of the integration that sent the metric if applicable. | [optional][readonly] | +| **per_unit** | **String** | Per unit of the metric such as `second` in `bytes per second`. | [optional] | +| **short_name** | **String** | A more human-readable and abbreviated version of the metric name. | [optional] | +| **statsd_interval** | **Integer** | StatsD flush interval of the metric in seconds if applicable. | [optional] | +| **type** | **String** | Metric type such as `gauge` or `rate`. | [optional] | +| **unit** | **String** | Primary unit of the metric such as `byte` or `operation`. | [optional] | ## Example @@ -27,4 +27,3 @@ instance = DatadogAPIClient::V1::MetricMetadata.new( unit: byte ) ``` - diff --git a/docs/v1/MetricSearchResponse.md b/docs/v1/MetricSearchResponse.md index 73a619cd09c7..56af613b2723 100644 --- a/docs/v1/MetricSearchResponse.md +++ b/docs/v1/MetricSearchResponse.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **results** | [**MetricSearchResponseResults**](MetricSearchResponseResults.md) | | [optional] | +| Name | Type | Description | Notes | +| ----------- | ----------------------------------------------------------------- | ----------- | ---------- | +| **results** | [**MetricSearchResponseResults**](MetricSearchResponseResults.md) | | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::MetricSearchResponse.new( results: null ) ``` - diff --git a/docs/v1/MetricSearchResponseResults.md b/docs/v1/MetricSearchResponseResults.md index 5603233f50bb..e80c6ebe86f2 100644 --- a/docs/v1/MetricSearchResponseResults.md +++ b/docs/v1/MetricSearchResponseResults.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| ----------- | ----------------------- | -------------------------------------------- | ---------- | | **metrics** | **Array<String>** | List of metrics that match the search query. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::MetricSearchResponseResults.new( metrics: null ) ``` - diff --git a/docs/v1/MetricsAPI.md b/docs/v1/MetricsAPI.md index 0bd5aca57a01..6edf61e0cca7 100644 --- a/docs/v1/MetricsAPI.md +++ b/docs/v1/MetricsAPI.md @@ -2,15 +2,14 @@ All URIs are relative to *https://api.datadoghq.com* -| Method | HTTP request | Description | -| ------ | ------------ | ----------- | -| [**get_metric_metadata**](MetricsAPI.md#get_metric_metadata) | **GET** /api/v1/metrics/{metric_name} | Get metric metadata | -| [**list_active_metrics**](MetricsAPI.md#list_active_metrics) | **GET** /api/v1/metrics | Get active metrics list | -| [**list_metrics**](MetricsAPI.md#list_metrics) | **GET** /api/v1/search | Search metrics | -| [**query_metrics**](MetricsAPI.md#query_metrics) | **GET** /api/v1/query | Query timeseries points | -| [**submit_metrics**](MetricsAPI.md#submit_metrics) | **POST** /api/v1/series | Submit metrics | -| [**update_metric_metadata**](MetricsAPI.md#update_metric_metadata) | **PUT** /api/v1/metrics/{metric_name} | Edit metric metadata | - +| Method | HTTP request | Description | +| ------------------------------------------------------------------ | ------------------------------------- | ----------------------- | +| [**get_metric_metadata**](MetricsAPI.md#get_metric_metadata) | **GET** /api/v1/metrics/{metric_name} | Get metric metadata | +| [**list_active_metrics**](MetricsAPI.md#list_active_metrics) | **GET** /api/v1/metrics | Get active metrics list | +| [**list_metrics**](MetricsAPI.md#list_metrics) | **GET** /api/v1/search | Search metrics | +| [**query_metrics**](MetricsAPI.md#query_metrics) | **GET** /api/v1/query | Query timeseries points | +| [**submit_metrics**](MetricsAPI.md#submit_metrics) | **POST** /api/v1/series | Submit metrics | +| [**update_metric_metadata**](MetricsAPI.md#update_metric_metadata) | **PUT** /api/v1/metrics/{metric_name} | Edit metric metadata | ## get_metric_metadata @@ -54,9 +53,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **metric_name** | **String** | Name of the metric for which to get metadata. | | +| Name | Type | Description | Notes | +| --------------- | ---------- | --------------------------------------------- | ----- | +| **metric_name** | **String** | Name of the metric for which to get metadata. | | ### Return type @@ -71,7 +70,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## list_active_metrics > list_active_metrics(from, opts) @@ -118,11 +116,11 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **from** | **Integer** | Seconds since the Unix epoch. | | -| **host** | **String** | Hostname for filtering the list of metrics returned. If set, metrics retrieved are those with the corresponding hostname tag. | [optional] | -| **tag_filter** | **String** | Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions. Cannot be combined with other filters. | [optional] | +| Name | Type | Description | Notes | +| -------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **from** | **Integer** | Seconds since the Unix epoch. | | +| **host** | **String** | Hostname for filtering the list of metrics returned. If set, metrics retrieved are those with the corresponding hostname tag. | [optional] | +| **tag_filter** | **String** | Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions. Cannot be combined with other filters. | [optional] | ### Return type @@ -137,7 +135,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## list_metrics > list_metrics(q) @@ -180,9 +177,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **q** | **String** | Query string to search metrics upon. Must be prefixed with `metrics:`. | | +| Name | Type | Description | Notes | +| ----- | ---------- | -------------------------------------------------------------------------------- | ----- | +| **q** | **String** | Query string to search metrics upon. Must be prefixed with `metrics:`. | | ### Return type @@ -197,7 +194,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## query_metrics > query_metrics(from, to, query) @@ -242,11 +238,11 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **from** | **Integer** | Start of the queried time period, seconds since the Unix epoch. | | -| **to** | **Integer** | End of the queried time period, seconds since the Unix epoch. | | -| **query** | **String** | Query string. | | +| Name | Type | Description | Notes | +| --------- | ----------- | --------------------------------------------------------------- | ----- | +| **from** | **Integer** | Start of the queried time period, seconds since the Unix epoch. | | +| **to** | **Integer** | End of the queried time period, seconds since the Unix epoch. | | +| **query** | **String** | Query string. | | ### Return type @@ -261,7 +257,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## submit_metrics > submit_metrics(body, opts) @@ -276,14 +271,14 @@ If you’re submitting metrics directly to the Datadog API without using DogStat - 20 bytes for the metric names - 50 bytes for the timeseries - The full payload is approximately 100 bytes. However, with the DogStatsD API, -compression is applied, which reduces the payload size. + compression is applied, which reduces the payload size. ### Examples ```ruby require 'datadog_api_client' api_instance = DatadogAPIClient::V1::MetricsAPI.new -body = DatadogAPIClient::V1::MetricsPayload.new({series: [DatadogAPIClient::V1::Series.new({metric: 'system.load.1', points: [[3.56]]})]}) # MetricsPayload | +body = DatadogAPIClient::V1::MetricsPayload.new({series: [DatadogAPIClient::V1::Series.new({metric: 'system.load.1', points: [[3.56]]})]}) # MetricsPayload | opts = { content_encoding: DatadogAPIClient::V1::MetricContentEncoding::DEFLATE # MetricContentEncoding | HTTP header used to compress the media-type. } @@ -317,10 +312,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**MetricsPayload**](MetricsPayload.md) | | | -| **content_encoding** | **MetricContentEncoding** | HTTP header used to compress the media-type. | [optional] | +| Name | Type | Description | Notes | +| -------------------- | --------------------------------------- | -------------------------------------------- | ---------- | +| **body** | [**MetricsPayload**](MetricsPayload.md) | | | +| **content_encoding** | **MetricContentEncoding** | HTTP header used to compress the media-type. | [optional] | ### Return type @@ -335,7 +330,6 @@ end - **Content-Type**: text/json - **Accept**: text/json - ## update_metric_metadata > update_metric_metadata(metric_name, body) @@ -379,10 +373,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **metric_name** | **String** | Name of the metric for which to edit metadata. | | -| **body** | [**MetricMetadata**](MetricMetadata.md) | New metadata. | | +| Name | Type | Description | Notes | +| --------------- | --------------------------------------- | ---------------------------------------------- | ----- | +| **metric_name** | **String** | Name of the metric for which to edit metadata. | | +| **body** | [**MetricMetadata**](MetricMetadata.md) | New metadata. | | ### Return type @@ -396,4 +390,3 @@ end - **Content-Type**: application/json - **Accept**: application/json - diff --git a/docs/v1/MetricsListResponse.md b/docs/v1/MetricsListResponse.md index 8b5a15044346..549d0a889811 100644 --- a/docs/v1/MetricsListResponse.md +++ b/docs/v1/MetricsListResponse.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **from** | **String** | Time when the metrics were active, seconds since the Unix epoch. | [optional] | -| **metrics** | **Array<String>** | List of metric names. | [optional] | +| Name | Type | Description | Notes | +| ----------- | ----------------------- | ---------------------------------------------------------------- | ---------- | +| **from** | **String** | Time when the metrics were active, seconds since the Unix epoch. | [optional] | +| **metrics** | **Array<String>** | List of metric names. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::MetricsListResponse.new( metrics: null ) ``` - diff --git a/docs/v1/MetricsPayload.md b/docs/v1/MetricsPayload.md index ea765f231828..a0ce38531d62 100644 --- a/docs/v1/MetricsPayload.md +++ b/docs/v1/MetricsPayload.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **series** | [**Array<Series>**](Series.md) | A list of time series to submit to Datadog. | | +| Name | Type | Description | Notes | +| ---------- | ------------------------------------ | ------------------------------------------- | ----- | +| **series** | [**Array<Series>**](Series.md) | A list of time series to submit to Datadog. | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::MetricsPayload.new( series: [{"metric":"system.load.1","points":[[1.475317847E9,0.7]]}] ) ``` - diff --git a/docs/v1/MetricsQueryMetadata.md b/docs/v1/MetricsQueryMetadata.md index e9ae9541123d..6268158e1d9b 100644 --- a/docs/v1/MetricsQueryMetadata.md +++ b/docs/v1/MetricsQueryMetadata.md @@ -2,21 +2,21 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **aggr** | **String** | Aggregation type. | [optional][readonly] | -| **display_name** | **String** | Display name of the metric. | [optional][readonly] | -| **_end** | **Integer** | End of the time window, milliseconds since Unix epoch. | [optional][readonly] | -| **expression** | **String** | Metric expression. | [optional][readonly] | -| **interval** | **Integer** | Number of seconds between data samples. | [optional][readonly] | -| **length** | **Integer** | Number of data samples. | [optional][readonly] | -| **metric** | **String** | Metric name. | [optional][readonly] | -| **pointlist** | **Array<Array>** | List of points of the time series. | [optional][readonly] | -| **query_index** | **Integer** | The index of the series' query within the request. | [optional][readonly] | -| **scope** | **String** | Metric scope, comma separated list of tags. | [optional][readonly] | -| **start** | **Integer** | Start of the time window, milliseconds since Unix epoch. | [optional][readonly] | -| **tag_set** | **Array<String>** | Unique tags identifying this series. | [optional][readonly] | -| **unit** | [**Array<MetricsQueryUnit>**](MetricsQueryUnit.md) | Detailed information about the metric unit. First element describes the \"primary unit\" (for example, `bytes` in `bytes per second`), second describes the \"per unit\" (for example, `second` in `bytes per second`). | [optional][readonly] | +| Name | Type | Description | Notes | +| ---------------- | -------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- | +| **aggr** | **String** | Aggregation type. | [optional][readonly] | +| **display_name** | **String** | Display name of the metric. | [optional][readonly] | +| **\_end** | **Integer** | End of the time window, milliseconds since Unix epoch. | [optional][readonly] | +| **expression** | **String** | Metric expression. | [optional][readonly] | +| **interval** | **Integer** | Number of seconds between data samples. | [optional][readonly] | +| **length** | **Integer** | Number of data samples. | [optional][readonly] | +| **metric** | **String** | Metric name. | [optional][readonly] | +| **pointlist** | **Array<Array>** | List of points of the time series. | [optional][readonly] | +| **query_index** | **Integer** | The index of the series' query within the request. | [optional][readonly] | +| **scope** | **String** | Metric scope, comma separated list of tags. | [optional][readonly] | +| **start** | **Integer** | Start of the time window, milliseconds since Unix epoch. | [optional][readonly] | +| **tag_set** | **Array<String>** | Unique tags identifying this series. | [optional][readonly] | +| **unit** | [**Array<MetricsQueryUnit>**](MetricsQueryUnit.md) | Detailed information about the metric unit. First element describes the \"primary unit\" (for example, `bytes` in `bytes per second`), second describes the \"per unit\" (for example, `second` in `bytes per second`). | [optional][readonly] | ## Example @@ -39,4 +39,3 @@ instance = DatadogAPIClient::V1::MetricsQueryMetadata.new( unit: null ) ``` - diff --git a/docs/v1/MetricsQueryResponse.md b/docs/v1/MetricsQueryResponse.md index d9d822b74ec7..248e042fd68f 100644 --- a/docs/v1/MetricsQueryResponse.md +++ b/docs/v1/MetricsQueryResponse.md @@ -2,17 +2,17 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **error** | **String** | Message indicating the errors if status is not `ok`. | [optional][readonly] | -| **from_date** | **Integer** | Start of requested time window, milliseconds since Unix epoch. | [optional][readonly] | -| **group_by** | **Array<String>** | List of tag keys on which to group. | [optional][readonly] | -| **message** | **String** | Message indicating `success` if status is `ok`. | [optional][readonly] | -| **query** | **String** | Query string | [optional][readonly] | -| **res_type** | **String** | Type of response. | [optional][readonly] | -| **series** | [**Array<MetricsQueryMetadata>**](MetricsQueryMetadata.md) | List of timeseries queried. | [optional][readonly] | -| **status** | **String** | Status of the query. | [optional][readonly] | -| **to_date** | **Integer** | End of requested time window, milliseconds since Unix epoch. | [optional][readonly] | +| Name | Type | Description | Notes | +| ------------- | ---------------------------------------------------------------- | ------------------------------------------------------------------- | -------------------- | +| **error** | **String** | Message indicating the errors if status is not `ok`. | [optional][readonly] | +| **from_date** | **Integer** | Start of requested time window, milliseconds since Unix epoch. | [optional][readonly] | +| **group_by** | **Array<String>** | List of tag keys on which to group. | [optional][readonly] | +| **message** | **String** | Message indicating `success` if status is `ok`. | [optional][readonly] | +| **query** | **String** | Query string | [optional][readonly] | +| **res_type** | **String** | Type of response. | [optional][readonly] | +| **series** | [**Array<MetricsQueryMetadata>**](MetricsQueryMetadata.md) | List of timeseries queried. | [optional][readonly] | +| **status** | **String** | Status of the query. | [optional][readonly] | +| **to_date** | **Integer** | End of requested time window, milliseconds since Unix epoch. | [optional][readonly] | ## Example @@ -31,4 +31,3 @@ instance = DatadogAPIClient::V1::MetricsQueryResponse.new( to_date: null ) ``` - diff --git a/docs/v1/MetricsQueryUnit.md b/docs/v1/MetricsQueryUnit.md index dc83b09bb400..04b62dedfe3c 100644 --- a/docs/v1/MetricsQueryUnit.md +++ b/docs/v1/MetricsQueryUnit.md @@ -2,13 +2,13 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **family** | **String** | Unit family, allows for conversion between units of the same family, for scaling. | [optional][readonly] | -| **name** | **String** | Unit name | [optional][readonly] | -| **plural** | **String** | Plural form of the unit name. | [optional][readonly] | -| **scale_factor** | **Float** | Factor for scaling between units of the same family. | [optional][readonly] | -| **short_name** | **String** | Abbreviation of the unit. | [optional][readonly] | +| Name | Type | Description | Notes | +| ---------------- | ---------- | --------------------------------------------------------------------------------- | -------------------- | +| **family** | **String** | Unit family, allows for conversion between units of the same family, for scaling. | [optional][readonly] | +| **name** | **String** | Unit name | [optional][readonly] | +| **plural** | **String** | Plural form of the unit name. | [optional][readonly] | +| **scale_factor** | **Float** | Factor for scaling between units of the same family. | [optional][readonly] | +| **short_name** | **String** | Abbreviation of the unit. | [optional][readonly] | ## Example @@ -23,4 +23,3 @@ instance = DatadogAPIClient::V1::MetricsQueryUnit.new( short_name: min ) ``` - diff --git a/docs/v1/Monitor.md b/docs/v1/Monitor.md index 1c57d3e0672c..a510b90b2992 100644 --- a/docs/v1/Monitor.md +++ b/docs/v1/Monitor.md @@ -2,24 +2,24 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **created** | **Time** | Timestamp of the monitor creation. | [optional][readonly] | -| **creator** | [**Creator**](Creator.md) | | [optional] | -| **deleted** | **Time** | Whether or not the monitor is deleted. (Always `null`) | [optional][readonly] | -| **id** | **Integer** | ID of this monitor. | [optional][readonly] | -| **message** | **String** | A message to include with notifications for this monitor. | [optional] | -| **modified** | **Time** | Last timestamp when the monitor was edited. | [optional][readonly] | -| **multi** | **Boolean** | Whether or not the monitor is broken down on different groups. | [optional][readonly] | -| **name** | **String** | The monitor name. | [optional] | -| **options** | [**MonitorOptions**](MonitorOptions.md) | | [optional] | -| **overall_state** | [**MonitorOverallStates**](MonitorOverallStates.md) | | [optional] | -| **priority** | **Integer** | Integer from 1 (high) to 5 (low) indicating alert severity. | [optional] | -| **query** | **String** | The monitor query. | | -| **restricted_roles** | **Array<String>** | A list of role identifiers that can be pulled from the Roles API. Cannot be used with `locked` option. | [optional] | -| **state** | [**MonitorState**](MonitorState.md) | | [optional] | -| **tags** | **Array<String>** | Tags associated to your monitor. | [optional] | -| **type** | [**MonitorType**](MonitorType.md) | | | +| Name | Type | Description | Notes | +| -------------------- | --------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -------------------- | +| **created** | **Time** | Timestamp of the monitor creation. | [optional][readonly] | +| **creator** | [**Creator**](Creator.md) | | [optional] | +| **deleted** | **Time** | Whether or not the monitor is deleted. (Always `null`) | [optional][readonly] | +| **id** | **Integer** | ID of this monitor. | [optional][readonly] | +| **message** | **String** | A message to include with notifications for this monitor. | [optional] | +| **modified** | **Time** | Last timestamp when the monitor was edited. | [optional][readonly] | +| **multi** | **Boolean** | Whether or not the monitor is broken down on different groups. | [optional][readonly] | +| **name** | **String** | The monitor name. | [optional] | +| **options** | [**MonitorOptions**](MonitorOptions.md) | | [optional] | +| **overall_state** | [**MonitorOverallStates**](MonitorOverallStates.md) | | [optional] | +| **priority** | **Integer** | Integer from 1 (high) to 5 (low) indicating alert severity. | [optional] | +| **query** | **String** | The monitor query. | | +| **restricted_roles** | **Array<String>** | A list of role identifiers that can be pulled from the Roles API. Cannot be used with `locked` option. | [optional] | +| **state** | [**MonitorState**](MonitorState.md) | | [optional] | +| **tags** | **Array<String>** | Tags associated to your monitor. | [optional] | +| **type** | [**MonitorType**](MonitorType.md) | | | ## Example @@ -45,4 +45,3 @@ instance = DatadogAPIClient::V1::Monitor.new( type: null ) ``` - diff --git a/docs/v1/MonitorDeviceID.md b/docs/v1/MonitorDeviceID.md index cc5d3214aa9d..839fa6d4489a 100644 --- a/docs/v1/MonitorDeviceID.md +++ b/docs/v1/MonitorDeviceID.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::MonitorDeviceID.new() ``` - diff --git a/docs/v1/MonitorGroupSearchResponse.md b/docs/v1/MonitorGroupSearchResponse.md index 9113ffb4548f..4e73c24e14d3 100644 --- a/docs/v1/MonitorGroupSearchResponse.md +++ b/docs/v1/MonitorGroupSearchResponse.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **counts** | [**MonitorGroupSearchResponseCounts**](MonitorGroupSearchResponseCounts.md) | | [optional] | -| **groups** | [**Array<MonitorGroupSearchResult>**](MonitorGroupSearchResult.md) | The list of found monitor groups. | [optional][readonly] | -| **metadata** | [**MonitorSearchResponseMetadata**](MonitorSearchResponseMetadata.md) | | [optional] | +| Name | Type | Description | Notes | +| ------------ | --------------------------------------------------------------------------- | --------------------------------- | -------------------- | +| **counts** | [**MonitorGroupSearchResponseCounts**](MonitorGroupSearchResponseCounts.md) | | [optional] | +| **groups** | [**Array<MonitorGroupSearchResult>**](MonitorGroupSearchResult.md) | The list of found monitor groups. | [optional][readonly] | +| **metadata** | [**MonitorSearchResponseMetadata**](MonitorSearchResponseMetadata.md) | | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::MonitorGroupSearchResponse.new( metadata: null ) ``` - diff --git a/docs/v1/MonitorGroupSearchResponseCounts.md b/docs/v1/MonitorGroupSearchResponseCounts.md index 7950aa768249..b4496f421e0f 100644 --- a/docs/v1/MonitorGroupSearchResponseCounts.md +++ b/docs/v1/MonitorGroupSearchResponseCounts.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| ---------- | ----------------------- | -------------- | ---------- | | **status** | **Array<Object>** | Search facets. | [optional] | -| **type** | **Array<Object>** | Search facets. | [optional] | +| **type** | **Array<Object>** | Search facets. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::MonitorGroupSearchResponseCounts.new( type: null ) ``` - diff --git a/docs/v1/MonitorGroupSearchResult.md b/docs/v1/MonitorGroupSearchResult.md index abb27b301c8b..536a5a3c8ef1 100644 --- a/docs/v1/MonitorGroupSearchResult.md +++ b/docs/v1/MonitorGroupSearchResult.md @@ -2,15 +2,15 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **group** | **String** | The name of the group. | [optional][readonly] | -| **group_tags** | **Array<String>** | The list of tags of the monitor group. | [optional][readonly] | -| **last_nodata_ts** | **Integer** | Latest timestamp the monitor group was in NO_DATA state. | [optional][readonly] | -| **last_triggered_ts** | **Integer** | Latest timestamp the monitor group triggered. | [optional][readonly] | -| **monitor_id** | **Integer** | The ID of the monitor. | [optional][readonly] | -| **monitor_name** | **String** | The name of the monitor. | [optional][readonly] | -| **status** | [**MonitorOverallStates**](MonitorOverallStates.md) | | [optional] | +| Name | Type | Description | Notes | +| --------------------- | --------------------------------------------------- | -------------------------------------------------------- | -------------------- | +| **group** | **String** | The name of the group. | [optional][readonly] | +| **group_tags** | **Array<String>** | The list of tags of the monitor group. | [optional][readonly] | +| **last_nodata_ts** | **Integer** | Latest timestamp the monitor group was in NO_DATA state. | [optional][readonly] | +| **last_triggered_ts** | **Integer** | Latest timestamp the monitor group triggered. | [optional][readonly] | +| **monitor_id** | **Integer** | The ID of the monitor. | [optional][readonly] | +| **monitor_name** | **String** | The name of the monitor. | [optional][readonly] | +| **status** | [**MonitorOverallStates**](MonitorOverallStates.md) | | [optional] | ## Example @@ -27,4 +27,3 @@ instance = DatadogAPIClient::V1::MonitorGroupSearchResult.new( status: null ) ``` - diff --git a/docs/v1/MonitorOptions.md b/docs/v1/MonitorOptions.md index a8d2f68bf6b4..3d42f63e1bf5 100644 --- a/docs/v1/MonitorOptions.md +++ b/docs/v1/MonitorOptions.md @@ -2,32 +2,32 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **aggregation** | [**MonitorOptionsAggregation**](MonitorOptionsAggregation.md) | | [optional] | -| **device_ids** | [**Array<MonitorDeviceID>**](MonitorDeviceID.md) | IDs of the device the Synthetics monitor is running on. | [optional][readonly] | -| **enable_logs_sample** | **Boolean** | Whether or not to send a log sample when the log monitor triggers. | [optional] | -| **escalation_message** | **String** | We recommend using the [is_renotify](https://docs.datadoghq.com/monitors/notify/?tab=is_alert#renotify), block in the original message instead. A message to include with a re-notification. Supports the `@username` notification we allow elsewhere. Not applicable if `renotify_interval` is `None`. | [optional][default to 'none'] | -| **evaluation_delay** | **Integer** | Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to `300` (5min), the timeframe is set to `last_5m` and the time is 7:00, the monitor evaluates data from 6:50 to 6:55. This is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor always has data during evaluation. | [optional] | -| **groupby_simple_monitor** | **Boolean** | Whether the log alert monitor triggers a single alert or multiple alerts when any group breaches a threshold. | [optional] | -| **include_tags** | **Boolean** | A Boolean indicating whether notifications from this monitor automatically inserts its triggering tags into the title. **Examples** - If `True`, `[Triggered on {host:h1}] Monitor Title` - If `False`, `[Triggered] Monitor Title` | [optional][default to true] | -| **locked** | **Boolean** | Whether or not the monitor is locked (only editable by creator and admins). | [optional] | -| **min_failure_duration** | **Integer** | How long the test should be in failure before alerting (integer, number of seconds, max 7200). | [optional][default to 0] | -| **min_location_failed** | **Integer** | The minimum number of locations in failure at the same time during at least one moment in the `min_failure_duration` period (`min_location_failed` and `min_failure_duration` are part of the advanced alerting rules - integer, >= 1). | [optional][default to 1] | -| **new_group_delay** | **Integer** | Time (in seconds) to skip evaluations for new groups. For example, this option can be used to skip evaluations for new hosts while they initialize. Must be a non negative integer. | [optional] | -| **new_host_delay** | **Integer** | Time (in seconds) to allow a host to boot and applications to fully start before starting the evaluation of monitor results. Should be a non negative integer. Use new_group_delay instead. | [optional][default to 300] | -| **no_data_timeframe** | **Integer** | The number of minutes before a monitor notifies after data stops reporting. Datadog recommends at least 2x the monitor timeframe for metric alerts or 2 minutes for service checks. If omitted, 2x the evaluation timeframe is used for metric alerts, and 24 hours is used for service checks. | [optional] | -| **notify_audit** | **Boolean** | A Boolean indicating whether tagged users is notified on changes to this monitor. | [optional][default to false] | -| **notify_no_data** | **Boolean** | A Boolean indicating whether this monitor notifies when data stops reporting. | [optional][default to false] | -| **renotify_interval** | **Integer** | The number of minutes after the last notification before a monitor re-notifies on the current status. It only re-notifies if it’s not resolved. | [optional] | -| **renotify_occurrences** | **Integer** | The number of times re-notification messages should be sent on the current status at the provided re-notification interval. | [optional] | -| **renotify_statuses** | [**Array<MonitorRenotifyStatusType>**](MonitorRenotifyStatusType.md) | The types of monitor statuses for which re-notification messages are sent. | [optional] | -| **require_full_window** | **Boolean** | A Boolean indicating whether this monitor needs a full window of data before it’s evaluated. We highly recommend you set this to `false` for sparse metrics, otherwise some evaluations are skipped. Default is false. | [optional] | -| **silenced** | **Hash<String, Integer>** | Information about the downtime applied to the monitor. | [optional] | -| **synthetics_check_id** | **String** | ID of the corresponding Synthetic check. | [optional] | -| **threshold_windows** | [**MonitorThresholdWindowOptions**](MonitorThresholdWindowOptions.md) | | [optional] | -| **thresholds** | [**MonitorThresholds**](MonitorThresholds.md) | | [optional] | -| **timeout_h** | **Integer** | The number of hours of the monitor not reporting data before it automatically resolves from a triggered state. | [optional] | +| Name | Type | Description | Notes | +| -------------------------- | -------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | +| **aggregation** | [**MonitorOptionsAggregation**](MonitorOptionsAggregation.md) | | [optional] | +| **device_ids** | [**Array<MonitorDeviceID>**](MonitorDeviceID.md) | IDs of the device the Synthetics monitor is running on. | [optional][readonly] | +| **enable_logs_sample** | **Boolean** | Whether or not to send a log sample when the log monitor triggers. | [optional] | +| **escalation_message** | **String** | We recommend using the [is_renotify](https://docs.datadoghq.com/monitors/notify/?tab=is_alert#renotify), block in the original message instead. A message to include with a re-notification. Supports the `@username` notification we allow elsewhere. Not applicable if `renotify_interval` is `None`. | [optional][default to 'none'] | +| **evaluation_delay** | **Integer** | Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to `300` (5min), the timeframe is set to `last_5m` and the time is 7:00, the monitor evaluates data from 6:50 to 6:55. This is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor always has data during evaluation. | [optional] | +| **groupby_simple_monitor** | **Boolean** | Whether the log alert monitor triggers a single alert or multiple alerts when any group breaches a threshold. | [optional] | +| **include_tags** | **Boolean** | A Boolean indicating whether notifications from this monitor automatically inserts its triggering tags into the title. **Examples** - If `True`, `[Triggered on {host:h1}] Monitor Title` - If `False`, `[Triggered] Monitor Title` | [optional][default to true] | +| **locked** | **Boolean** | Whether or not the monitor is locked (only editable by creator and admins). | [optional] | +| **min_failure_duration** | **Integer** | How long the test should be in failure before alerting (integer, number of seconds, max 7200). | [optional][default to 0] | +| **min_location_failed** | **Integer** | The minimum number of locations in failure at the same time during at least one moment in the `min_failure_duration` period (`min_location_failed` and `min_failure_duration` are part of the advanced alerting rules - integer, >= 1). | [optional][default to 1] | +| **new_group_delay** | **Integer** | Time (in seconds) to skip evaluations for new groups. For example, this option can be used to skip evaluations for new hosts while they initialize. Must be a non negative integer. | [optional] | +| **new_host_delay** | **Integer** | Time (in seconds) to allow a host to boot and applications to fully start before starting the evaluation of monitor results. Should be a non negative integer. Use new_group_delay instead. | [optional][default to 300] | +| **no_data_timeframe** | **Integer** | The number of minutes before a monitor notifies after data stops reporting. Datadog recommends at least 2x the monitor timeframe for metric alerts or 2 minutes for service checks. If omitted, 2x the evaluation timeframe is used for metric alerts, and 24 hours is used for service checks. | [optional] | +| **notify_audit** | **Boolean** | A Boolean indicating whether tagged users is notified on changes to this monitor. | [optional][default to false] | +| **notify_no_data** | **Boolean** | A Boolean indicating whether this monitor notifies when data stops reporting. | [optional][default to false] | +| **renotify_interval** | **Integer** | The number of minutes after the last notification before a monitor re-notifies on the current status. It only re-notifies if it’s not resolved. | [optional] | +| **renotify_occurrences** | **Integer** | The number of times re-notification messages should be sent on the current status at the provided re-notification interval. | [optional] | +| **renotify_statuses** | [**Array<MonitorRenotifyStatusType>**](MonitorRenotifyStatusType.md) | The types of monitor statuses for which re-notification messages are sent. | [optional] | +| **require_full_window** | **Boolean** | A Boolean indicating whether this monitor needs a full window of data before it’s evaluated. We highly recommend you set this to `false` for sparse metrics, otherwise some evaluations are skipped. Default is false. | [optional] | +| **silenced** | **Hash<String, Integer>** | Information about the downtime applied to the monitor. | [optional] | +| **synthetics_check_id** | **String** | ID of the corresponding Synthetic check. | [optional] | +| **threshold_windows** | [**MonitorThresholdWindowOptions**](MonitorThresholdWindowOptions.md) | | [optional] | +| **thresholds** | [**MonitorThresholds**](MonitorThresholds.md) | | [optional] | +| **timeout_h** | **Integer** | The number of hours of the monitor not reporting data before it automatically resolves from a triggered state. | [optional] | ## Example @@ -61,4 +61,3 @@ instance = DatadogAPIClient::V1::MonitorOptions.new( timeout_h: null ) ``` - diff --git a/docs/v1/MonitorOptionsAggregation.md b/docs/v1/MonitorOptionsAggregation.md index a344fbf47d3a..6b05598974f9 100644 --- a/docs/v1/MonitorOptionsAggregation.md +++ b/docs/v1/MonitorOptionsAggregation.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| ------------ | ---------- | ----------------------------------- | ---------- | | **group_by** | **String** | Group to break down the monitor on. | [optional] | -| **metric** | **String** | Metric name used in the monitor. | [optional] | -| **type** | **String** | Metric type used in the monitor. | [optional] | +| **metric** | **String** | Metric name used in the monitor. | [optional] | +| **type** | **String** | Metric type used in the monitor. | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::MonitorOptionsAggregation.new( type: count ) ``` - diff --git a/docs/v1/MonitorOverallStates.md b/docs/v1/MonitorOverallStates.md index 787872a11032..36c6caefc190 100644 --- a/docs/v1/MonitorOverallStates.md +++ b/docs/v1/MonitorOverallStates.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::MonitorOverallStates.new() ``` - diff --git a/docs/v1/MonitorRenotifyStatusType.md b/docs/v1/MonitorRenotifyStatusType.md index 04c00bf25521..b5e8e53b3022 100644 --- a/docs/v1/MonitorRenotifyStatusType.md +++ b/docs/v1/MonitorRenotifyStatusType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::MonitorRenotifyStatusType.new() ``` - diff --git a/docs/v1/MonitorSearchResponse.md b/docs/v1/MonitorSearchResponse.md index 085b23cefc61..f460c3ad93f7 100644 --- a/docs/v1/MonitorSearchResponse.md +++ b/docs/v1/MonitorSearchResponse.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **counts** | [**MonitorSearchResponseCounts**](MonitorSearchResponseCounts.md) | | [optional] | -| **metadata** | [**MonitorSearchResponseMetadata**](MonitorSearchResponseMetadata.md) | | [optional] | -| **monitors** | [**Array<MonitorSearchResult>**](MonitorSearchResult.md) | The list of found monitors. | [optional][readonly] | +| Name | Type | Description | Notes | +| ------------ | --------------------------------------------------------------------- | --------------------------- | -------------------- | +| **counts** | [**MonitorSearchResponseCounts**](MonitorSearchResponseCounts.md) | | [optional] | +| **metadata** | [**MonitorSearchResponseMetadata**](MonitorSearchResponseMetadata.md) | | [optional] | +| **monitors** | [**Array<MonitorSearchResult>**](MonitorSearchResult.md) | The list of found monitors. | [optional][readonly] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::MonitorSearchResponse.new( monitors: null ) ``` - diff --git a/docs/v1/MonitorSearchResponseCounts.md b/docs/v1/MonitorSearchResponseCounts.md index 177571dc50bf..bbaf73148265 100644 --- a/docs/v1/MonitorSearchResponseCounts.md +++ b/docs/v1/MonitorSearchResponseCounts.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **muted** | **Array<Object>** | Search facets. | [optional] | +| Name | Type | Description | Notes | +| ---------- | ----------------------- | -------------- | ---------- | +| **muted** | **Array<Object>** | Search facets. | [optional] | | **status** | **Array<Object>** | Search facets. | [optional] | -| **tag** | **Array<Object>** | Search facets. | [optional] | -| **type** | **Array<Object>** | Search facets. | [optional] | +| **tag** | **Array<Object>** | Search facets. | [optional] | +| **type** | **Array<Object>** | Search facets. | [optional] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V1::MonitorSearchResponseCounts.new( type: null ) ``` - diff --git a/docs/v1/MonitorSearchResponseMetadata.md b/docs/v1/MonitorSearchResponseMetadata.md index 71deaad5b509..32fca1727677 100644 --- a/docs/v1/MonitorSearchResponseMetadata.md +++ b/docs/v1/MonitorSearchResponseMetadata.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **page** | **Integer** | The page to start paginating from. | [optional][readonly] | -| **page_count** | **Integer** | The number of pages. | [optional][readonly] | -| **per_page** | **Integer** | The number of monitors to return per page. | [optional][readonly] | -| **total_count** | **Integer** | The total number of monitors. | [optional][readonly] | +| Name | Type | Description | Notes | +| --------------- | ----------- | ------------------------------------------ | -------------------- | +| **page** | **Integer** | The page to start paginating from. | [optional][readonly] | +| **page_count** | **Integer** | The number of pages. | [optional][readonly] | +| **per_page** | **Integer** | The number of monitors to return per page. | [optional][readonly] | +| **total_count** | **Integer** | The total number of monitors. | [optional][readonly] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V1::MonitorSearchResponseMetadata.new( total_count: null ) ``` - diff --git a/docs/v1/MonitorSearchResult.md b/docs/v1/MonitorSearchResult.md index 03073d455720..4ad8fd6913cb 100644 --- a/docs/v1/MonitorSearchResult.md +++ b/docs/v1/MonitorSearchResult.md @@ -2,20 +2,20 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **classification** | **String** | Classification of the monitor. | [optional][readonly] | -| **creator** | [**Creator**](Creator.md) | | [optional] | -| **id** | **Integer** | ID of the monitor. | [optional][readonly] | -| **last_triggered_ts** | **Integer** | Latest timestamp the monitor triggered. | [optional][readonly] | -| **metrics** | **Array<String>** | Metrics used by the monitor. | [optional][readonly] | -| **name** | **String** | The monitor name. | [optional][readonly] | -| **notifications** | [**Array<MonitorSearchResultNotification>**](MonitorSearchResultNotification.md) | The notification triggered by the monitor. | [optional][readonly] | -| **org_id** | **Integer** | The ID of the organization. | [optional][readonly] | -| **scopes** | **Array<String>** | The scope(s) to which the downtime applies, e.g. `host:app2`. Provide multiple scopes as a comma-separated list, e.g. `env:dev,env:prod`. The resulting downtime applies to sources that matches ALL provided scopes (i.e. `env:dev AND env:prod`), NOT any of them. | [optional] | -| **status** | [**MonitorOverallStates**](MonitorOverallStates.md) | | [optional] | -| **tags** | **Array<String>** | Tags associated with the monitor. | [optional][readonly] | -| **type** | [**MonitorType**](MonitorType.md) | | [optional] | +| Name | Type | Description | Notes | +| --------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- | +| **classification** | **String** | Classification of the monitor. | [optional][readonly] | +| **creator** | [**Creator**](Creator.md) | | [optional] | +| **id** | **Integer** | ID of the monitor. | [optional][readonly] | +| **last_triggered_ts** | **Integer** | Latest timestamp the monitor triggered. | [optional][readonly] | +| **metrics** | **Array<String>** | Metrics used by the monitor. | [optional][readonly] | +| **name** | **String** | The monitor name. | [optional][readonly] | +| **notifications** | [**Array<MonitorSearchResultNotification>**](MonitorSearchResultNotification.md) | The notification triggered by the monitor. | [optional][readonly] | +| **org_id** | **Integer** | The ID of the organization. | [optional][readonly] | +| **scopes** | **Array<String>** | The scope(s) to which the downtime applies, e.g. `host:app2`. Provide multiple scopes as a comma-separated list, e.g. `env:dev,env:prod`. The resulting downtime applies to sources that matches ALL provided scopes (i.e. `env:dev AND env:prod`), NOT any of them. | [optional] | +| **status** | [**MonitorOverallStates**](MonitorOverallStates.md) | | [optional] | +| **tags** | **Array<String>** | Tags associated with the monitor. | [optional][readonly] | +| **type** | [**MonitorType**](MonitorType.md) | | [optional] | ## Example @@ -37,4 +37,3 @@ instance = DatadogAPIClient::V1::MonitorSearchResult.new( type: null ) ``` - diff --git a/docs/v1/MonitorSearchResultNotification.md b/docs/v1/MonitorSearchResultNotification.md index 798067d683e6..85e40b21dc4f 100644 --- a/docs/v1/MonitorSearchResultNotification.md +++ b/docs/v1/MonitorSearchResultNotification.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| ---------- | ---------- | ------------------------------------------------- | -------------------- | | **handle** | **String** | The email address that received the notification. | [optional][readonly] | -| **name** | **String** | The username receiving the notification | [optional][readonly] | +| **name** | **String** | The username receiving the notification | [optional][readonly] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::MonitorSearchResultNotification.new( name: null ) ``` - diff --git a/docs/v1/MonitorState.md b/docs/v1/MonitorState.md index aed409d0b55c..cb8275a61079 100644 --- a/docs/v1/MonitorState.md +++ b/docs/v1/MonitorState.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| ---------- | ----------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | ---------- | | **groups** | [**Hash<String, MonitorStateGroup>**](MonitorStateGroup.md) | Dictionary where the keys are groups (comma separated lists of tags) and the values are the list of groups your monitor is broken down on. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::MonitorState.new( groups: null ) ``` - diff --git a/docs/v1/MonitorStateGroup.md b/docs/v1/MonitorStateGroup.md index 66d57788beff..48855d227b55 100644 --- a/docs/v1/MonitorStateGroup.md +++ b/docs/v1/MonitorStateGroup.md @@ -2,14 +2,14 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **last_nodata_ts** | **Integer** | Latest timestamp the monitor was in NO_DATA state. | [optional] | -| **last_notified_ts** | **Integer** | Latest timestamp of the notification sent for this monitor group. | [optional] | -| **last_resolved_ts** | **Integer** | Latest timestamp the monitor group was resolved. | [optional] | -| **last_triggered_ts** | **Integer** | Latest timestamp the monitor group triggered. | [optional] | -| **name** | **String** | The name of the monitor. | [optional] | -| **status** | [**MonitorOverallStates**](MonitorOverallStates.md) | | [optional] | +| Name | Type | Description | Notes | +| --------------------- | --------------------------------------------------- | ----------------------------------------------------------------- | ---------- | +| **last_nodata_ts** | **Integer** | Latest timestamp the monitor was in NO_DATA state. | [optional] | +| **last_notified_ts** | **Integer** | Latest timestamp of the notification sent for this monitor group. | [optional] | +| **last_resolved_ts** | **Integer** | Latest timestamp the monitor group was resolved. | [optional] | +| **last_triggered_ts** | **Integer** | Latest timestamp the monitor group triggered. | [optional] | +| **name** | **String** | The name of the monitor. | [optional] | +| **status** | [**MonitorOverallStates**](MonitorOverallStates.md) | | [optional] | ## Example @@ -25,4 +25,3 @@ instance = DatadogAPIClient::V1::MonitorStateGroup.new( status: null ) ``` - diff --git a/docs/v1/MonitorSummaryWidgetDefinition.md b/docs/v1/MonitorSummaryWidgetDefinition.md index 367bfcde53f5..3d80f2a38fc7 100644 --- a/docs/v1/MonitorSummaryWidgetDefinition.md +++ b/docs/v1/MonitorSummaryWidgetDefinition.md @@ -2,21 +2,21 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **color_preference** | [**WidgetColorPreference**](WidgetColorPreference.md) | | [optional] | -| **count** | **Integer** | The number of monitors to display. | [optional] | -| **display_format** | [**WidgetMonitorSummaryDisplayFormat**](WidgetMonitorSummaryDisplayFormat.md) | | [optional] | -| **hide_zero_counts** | **Boolean** | Whether to show counts of 0 or not. | [optional] | -| **query** | **String** | Query to filter the monitors with. | | -| **show_last_triggered** | **Boolean** | Whether to show the time that has elapsed since the monitor/group triggered. | [optional] | -| **sort** | [**WidgetMonitorSummarySort**](WidgetMonitorSummarySort.md) | | [optional] | -| **start** | **Integer** | The start of the list. Typically 0. | [optional] | -| **summary_type** | [**WidgetSummaryType**](WidgetSummaryType.md) | | [optional] | -| **title** | **String** | Title of the widget. | [optional] | -| **title_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | -| **title_size** | **String** | Size of the title. | [optional] | -| **type** | [**MonitorSummaryWidgetDefinitionType**](MonitorSummaryWidgetDefinitionType.md) | | [default to 'manage_status'] | +| Name | Type | Description | Notes | +| ----------------------- | ------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ------------------------------------ | +| **color_preference** | [**WidgetColorPreference**](WidgetColorPreference.md) | | [optional] | +| **count** | **Integer** | The number of monitors to display. | [optional] | +| **display_format** | [**WidgetMonitorSummaryDisplayFormat**](WidgetMonitorSummaryDisplayFormat.md) | | [optional] | +| **hide_zero_counts** | **Boolean** | Whether to show counts of 0 or not. | [optional] | +| **query** | **String** | Query to filter the monitors with. | | +| **show_last_triggered** | **Boolean** | Whether to show the time that has elapsed since the monitor/group triggered. | [optional] | +| **sort** | [**WidgetMonitorSummarySort**](WidgetMonitorSummarySort.md) | | [optional] | +| **start** | **Integer** | The start of the list. Typically 0. | [optional] | +| **summary_type** | [**WidgetSummaryType**](WidgetSummaryType.md) | | [optional] | +| **title** | **String** | Title of the widget. | [optional] | +| **title_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | +| **title_size** | **String** | Size of the title. | [optional] | +| **type** | [**MonitorSummaryWidgetDefinitionType**](MonitorSummaryWidgetDefinitionType.md) | | [default to 'manage_status'] | ## Example @@ -39,4 +39,3 @@ instance = DatadogAPIClient::V1::MonitorSummaryWidgetDefinition.new( type: null ) ``` - diff --git a/docs/v1/MonitorSummaryWidgetDefinitionType.md b/docs/v1/MonitorSummaryWidgetDefinitionType.md index 292989095d8a..4e7dc8266158 100644 --- a/docs/v1/MonitorSummaryWidgetDefinitionType.md +++ b/docs/v1/MonitorSummaryWidgetDefinitionType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::MonitorSummaryWidgetDefinitionType.new() ``` - diff --git a/docs/v1/MonitorThresholdWindowOptions.md b/docs/v1/MonitorThresholdWindowOptions.md index 85716971169b..97ce78afb577 100644 --- a/docs/v1/MonitorThresholdWindowOptions.md +++ b/docs/v1/MonitorThresholdWindowOptions.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| ------------------- | ---------- | -------------------------------------------------------------------------------- | ---------- | | **recovery_window** | **String** | Describes how long an anomalous metric must be normal before the alert recovers. | [optional] | -| **trigger_window** | **String** | Describes how long a metric must be anomalous before an alert triggers. | [optional] | +| **trigger_window** | **String** | Describes how long a metric must be anomalous before an alert triggers. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::MonitorThresholdWindowOptions.new( trigger_window: null ) ``` - diff --git a/docs/v1/MonitorThresholds.md b/docs/v1/MonitorThresholds.md index ad1659916bbe..d3982f07929b 100644 --- a/docs/v1/MonitorThresholds.md +++ b/docs/v1/MonitorThresholds.md @@ -2,14 +2,14 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **critical** | **Float** | The monitor `CRITICAL` threshold. | [optional] | +| Name | Type | Description | Notes | +| --------------------- | --------- | ---------------------------------------------------- | ---------- | +| **critical** | **Float** | The monitor `CRITICAL` threshold. | [optional] | | **critical_recovery** | **Float** | The monitor `CRITICAL` recovery threshold. | [optional] | -| **ok** | **Float** | The monitor `OK` threshold. | [optional] | -| **unknown** | **Float** | The monitor UNKNOWN threshold. | [optional] | -| **warning** | **Float** | The monitor `WARNING` threshold. | [optional] | -| **warning_recovery** | **Float** | The monitor `WARNING` recovery threshold. | [optional] | +| **ok** | **Float** | The monitor `OK` threshold. | [optional] | +| **unknown** | **Float** | The monitor UNKNOWN threshold. | [optional] | +| **warning** | **Float** | The monitor `WARNING` threshold. | [optional] | +| **warning_recovery** | **Float** | The monitor `WARNING` recovery threshold. | [optional] | ## Example @@ -25,4 +25,3 @@ instance = DatadogAPIClient::V1::MonitorThresholds.new( warning_recovery: null ) ``` - diff --git a/docs/v1/MonitorType.md b/docs/v1/MonitorType.md index 202f7ec81e6d..5899d2036160 100644 --- a/docs/v1/MonitorType.md +++ b/docs/v1/MonitorType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::MonitorType.new() ``` - diff --git a/docs/v1/MonitorUpdateRequest.md b/docs/v1/MonitorUpdateRequest.md index e680047a5901..58713a2bf0e4 100644 --- a/docs/v1/MonitorUpdateRequest.md +++ b/docs/v1/MonitorUpdateRequest.md @@ -2,24 +2,24 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **created** | **Time** | Timestamp of the monitor creation. | [optional][readonly] | -| **creator** | [**Creator**](Creator.md) | | [optional] | -| **deleted** | **Time** | Whether or not the monitor is deleted. (Always `null`) | [optional][readonly] | -| **id** | **Integer** | ID of this monitor. | [optional][readonly] | -| **message** | **String** | A message to include with notifications for this monitor. | [optional] | -| **modified** | **Time** | Last timestamp when the monitor was edited. | [optional][readonly] | -| **multi** | **Boolean** | Whether or not the monitor is broken down on different groups. | [optional][readonly] | -| **name** | **String** | The monitor name. | [optional] | -| **options** | [**MonitorOptions**](MonitorOptions.md) | | [optional] | -| **overall_state** | [**MonitorOverallStates**](MonitorOverallStates.md) | | [optional] | -| **priority** | **Integer** | Integer from 1 (high) to 5 (low) indicating alert severity. | [optional] | -| **query** | **String** | The monitor query. | [optional] | -| **restricted_roles** | **Array<String>** | A list of role identifiers that can be pulled from the Roles API. Cannot be used with `locked` option. | [optional] | -| **state** | [**MonitorState**](MonitorState.md) | | [optional] | -| **tags** | **Array<String>** | Tags associated to your monitor. | [optional] | -| **type** | [**MonitorType**](MonitorType.md) | | [optional] | +| Name | Type | Description | Notes | +| -------------------- | --------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -------------------- | +| **created** | **Time** | Timestamp of the monitor creation. | [optional][readonly] | +| **creator** | [**Creator**](Creator.md) | | [optional] | +| **deleted** | **Time** | Whether or not the monitor is deleted. (Always `null`) | [optional][readonly] | +| **id** | **Integer** | ID of this monitor. | [optional][readonly] | +| **message** | **String** | A message to include with notifications for this monitor. | [optional] | +| **modified** | **Time** | Last timestamp when the monitor was edited. | [optional][readonly] | +| **multi** | **Boolean** | Whether or not the monitor is broken down on different groups. | [optional][readonly] | +| **name** | **String** | The monitor name. | [optional] | +| **options** | [**MonitorOptions**](MonitorOptions.md) | | [optional] | +| **overall_state** | [**MonitorOverallStates**](MonitorOverallStates.md) | | [optional] | +| **priority** | **Integer** | Integer from 1 (high) to 5 (low) indicating alert severity. | [optional] | +| **query** | **String** | The monitor query. | [optional] | +| **restricted_roles** | **Array<String>** | A list of role identifiers that can be pulled from the Roles API. Cannot be used with `locked` option. | [optional] | +| **state** | [**MonitorState**](MonitorState.md) | | [optional] | +| **tags** | **Array<String>** | Tags associated to your monitor. | [optional] | +| **type** | [**MonitorType**](MonitorType.md) | | [optional] | ## Example @@ -45,4 +45,3 @@ instance = DatadogAPIClient::V1::MonitorUpdateRequest.new( type: null ) ``` - diff --git a/docs/v1/MonitorsAPI.md b/docs/v1/MonitorsAPI.md index 9e8d59f14f0a..3d9b3b512ae1 100644 --- a/docs/v1/MonitorsAPI.md +++ b/docs/v1/MonitorsAPI.md @@ -2,18 +2,17 @@ All URIs are relative to *https://api.datadoghq.com* -| Method | HTTP request | Description | -| ------ | ------------ | ----------- | -| [**check_can_delete_monitor**](MonitorsAPI.md#check_can_delete_monitor) | **GET** /api/v1/monitor/can_delete | Check if a monitor can be deleted | -| [**create_monitor**](MonitorsAPI.md#create_monitor) | **POST** /api/v1/monitor | Create a monitor | -| [**delete_monitor**](MonitorsAPI.md#delete_monitor) | **DELETE** /api/v1/monitor/{monitor_id} | Delete a monitor | -| [**get_monitor**](MonitorsAPI.md#get_monitor) | **GET** /api/v1/monitor/{monitor_id} | Get a monitor's details | -| [**list_monitors**](MonitorsAPI.md#list_monitors) | **GET** /api/v1/monitor | Get all monitor details | -| [**search_monitor_groups**](MonitorsAPI.md#search_monitor_groups) | **GET** /api/v1/monitor/groups/search | Monitors group search | -| [**search_monitors**](MonitorsAPI.md#search_monitors) | **GET** /api/v1/monitor/search | Monitors search | -| [**update_monitor**](MonitorsAPI.md#update_monitor) | **PUT** /api/v1/monitor/{monitor_id} | Edit a monitor | -| [**validate_monitor**](MonitorsAPI.md#validate_monitor) | **POST** /api/v1/monitor/validate | Validate a monitor | - +| Method | HTTP request | Description | +| ----------------------------------------------------------------------- | --------------------------------------- | --------------------------------- | +| [**check_can_delete_monitor**](MonitorsAPI.md#check_can_delete_monitor) | **GET** /api/v1/monitor/can_delete | Check if a monitor can be deleted | +| [**create_monitor**](MonitorsAPI.md#create_monitor) | **POST** /api/v1/monitor | Create a monitor | +| [**delete_monitor**](MonitorsAPI.md#delete_monitor) | **DELETE** /api/v1/monitor/{monitor_id} | Delete a monitor | +| [**get_monitor**](MonitorsAPI.md#get_monitor) | **GET** /api/v1/monitor/{monitor_id} | Get a monitor's details | +| [**list_monitors**](MonitorsAPI.md#list_monitors) | **GET** /api/v1/monitor | Get all monitor details | +| [**search_monitor_groups**](MonitorsAPI.md#search_monitor_groups) | **GET** /api/v1/monitor/groups/search | Monitors group search | +| [**search_monitors**](MonitorsAPI.md#search_monitors) | **GET** /api/v1/monitor/search | Monitors search | +| [**update_monitor**](MonitorsAPI.md#update_monitor) | **PUT** /api/v1/monitor/{monitor_id} | Edit a monitor | +| [**validate_monitor**](MonitorsAPI.md#validate_monitor) | **POST** /api/v1/monitor/validate | Validate a monitor | ## check_can_delete_monitor @@ -57,9 +56,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **monitor_ids** | **Array<Integer>** | The IDs of the monitor to check. | | +| Name | Type | Description | Notes | +| --------------- | ------------------------ | -------------------------------- | ----- | +| **monitor_ids** | **Array<Integer>** | The IDs of the monitor to check. | | ### Return type @@ -74,7 +73,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## create_monitor > create_monitor(body) @@ -114,17 +112,16 @@ Example: `time_aggr(time_window):space_aggr:metric{tags} [by {key}] operator #` - `time_aggr`: avg, sum, max, min, change, or pct_change - `time_window`: `last_#m` (with `#` between 1 and 10080 depending on the monitor type) or `last_#h`(with `#` between 1 and 168 depending on the monitor type) or `last_1d`, or `last_1w` - `space_aggr`: avg, sum, min, or max -- `tags`: one or more tags (comma-separated), or * +- `tags`: one or more tags (comma-separated), or \* - `key`: a 'key' in key:value tag syntax; defines a separate alert for each tag in the group (multi-alert) - `operator`: <, <=, >, >=, ==, or != - `#`: an integer or decimal number used to set the threshold -If you are using the `_change_` or `_pct_change_` time aggregator, instead use `change_aggr(time_aggr(time_window), -timeshift):space_aggr:metric{tags} [by {key}] operator #` with: +If you are using the `_change_` or `_pct_change_` time aggregator, instead use `change_aggr(time_aggr(time_window), timeshift):space_aggr:metric{tags} [by {key}] operator #` with: - `change_aggr` change, pct_change - `time_aggr` avg, sum, max, min [Learn more](https://docs.datadoghq.com/monitors/create/types/#define-the-conditions) -- `time_window` last\_#m (between 1 and 2880 depending on the monitor type), last\_#h (between 1 and 48 depending on the monitor type), or last_#d (1 or 2) +- `time_window` last\_#m (between 1 and 2880 depending on the monitor type), last\_#h (between 1 and 48 depending on the monitor type), or last\_#d (1 or 2) - `timeshift` #m_ago (5, 10, 15, or 30), #h_ago (1, 2, or 4), or 1d_ago Use this to create an outlier monitor using the following query: @@ -135,11 +132,11 @@ Use this to create an outlier monitor using the following query: Example: `"check".over(tags).last(count).by(group).count_by_status()` - **`check`** name of the check, e.g. `datadog.agent.up` -- **`tags`** one or more quoted tags (comma-separated), or "*". e.g.: `.over("env:prod", "role:db")`; **`over`** cannot be blank. +- **`tags`** one or more quoted tags (comma-separated), or "\*". e.g.: `.over("env:prod", "role:db")`; **`over`** cannot be blank. - **`count`** must be at greater than or equal to your max threshold (defined in the `options`). It is limited to 100. -For example, if you've specified to notify on 1 critical, 3 ok, and 2 warn statuses, `count` should be at least 3. + For example, if you've specified to notify on 1 critical, 3 ok, and 2 warn statuses, `count` should be at least 3. - **`group`** must be specified for check monitors. Per-check grouping is already explicitly known for some service checks. -For example, Postgres integration monitors are tagged by `db`, `host`, and `port`, and Network monitors by `host`, `instance`, and `url`. See [Service Checks](https://docs.datadoghq.com/api/latest/service-checks/) documentation for more information. + For example, Postgres integration monitors are tagged by `db`, `host`, and `port`, and Network monitors by `host`, `instance`, and `url`. See [Service Checks](https://docs.datadoghq.com/api/latest/service-checks/) documentation for more information. **Event Alert Query** @@ -176,7 +173,7 @@ Example: `events(query).rollup(rollup_method[, measure]).last(time_window) opera Example: `processes(search).over(tags).rollup('count').last(timeframe) operator #` - **`search`** free text search string for querying processes. -Matching processes match results on the [Live Processes](https://docs.datadoghq.com/infrastructure/process/?tab=linuxwindows) page. + Matching processes match results on the [Live Processes](https://docs.datadoghq.com/infrastructure/process/?tab=linuxwindows) page. - **`tags`** one or more tags (comma-separated) - **`timeframe`** the timeframe to roll up the counts. Examples: 10m, 4h. Supported timeframes: s, m, h and d - **`operator`** <, <=, >, >=, ==, or != @@ -198,12 +195,12 @@ Example: `logs(query).index(index_name).rollup(rollup_method[, measure]).last(ti Example: `12345 && 67890`, where `12345` and `67890` are the IDs of non-composite monitors -* **`name`** [*required*, *default* = **dynamic, based on query**]: The name of the alert. -* **`message`** [*required*, *default* = **dynamic, based on query**]: A message to include with notifications for this monitor. -Email notifications can be sent to specific users by using the same '@username' notation as events. -* **`tags`** [*optional*, *default* = **empty list**]: A list of tags to associate with your monitor. -When getting all monitor details via the API, use the `monitor_tags` argument to filter results by these tags. -It is only available via the API and isn't visible or editable in the Datadog UI. +- **`name`** [*required*, *default* = **dynamic, based on query**]: The name of the alert. +- **`message`** [*required*, *default* = **dynamic, based on query**]: A message to include with notifications for this monitor. + Email notifications can be sent to specific users by using the same '@username' notation as events. +- **`tags`** [*optional*, *default* = **empty list**]: A list of tags to associate with your monitor. + When getting all monitor details via the API, use the `monitor_tags` argument to filter results by these tags. + It is only available via the API and isn't visible or editable in the Datadog UI. **SLO Alert Query** @@ -262,9 +259,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**Monitor**](Monitor.md) | Create a monitor request body. | | +| Name | Type | Description | Notes | +| -------- | ------------------------- | ------------------------------ | ----- | +| **body** | [**Monitor**](Monitor.md) | Create a monitor request body. | | ### Return type @@ -279,7 +276,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## delete_monitor > delete_monitor(monitor_id, opts) @@ -325,10 +321,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **monitor_id** | **Integer** | The ID of the monitor. | | -| **force** | **String** | Delete the monitor even if it's referenced by other resources (e.g. SLO, composite monitor). | [optional] | +| Name | Type | Description | Notes | +| -------------- | ----------- | ------------------------------------------------------------------------------------------------ | ---------- | +| **monitor_id** | **Integer** | The ID of the monitor. | | +| **force** | **String** | Delete the monitor even if it's referenced by other resources (e.g. SLO, composite monitor). | [optional] | ### Return type @@ -343,7 +339,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## get_monitor > get_monitor(monitor_id, opts) @@ -389,10 +384,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **monitor_id** | **Integer** | The ID of the monitor | | -| **group_states** | **String** | When specified, shows additional information about the group states. Choose one or more from `all`, `alert`, `warn`, and `no data`. | [optional] | +| Name | Type | Description | Notes | +| ---------------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **monitor_id** | **Integer** | The ID of the monitor | | +| **group_states** | **String** | When specified, shows additional information about the group states. Choose one or more from `all`, `alert`, `warn`, and `no data`. | [optional] | ### Return type @@ -407,7 +402,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## list_monitors > > list_monitors(opts) @@ -459,16 +453,16 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **group_states** | **String** | When specified, shows additional information about the group states. Choose one or more from `all`, `alert`, `warn`, and `no data`. | [optional] | -| **name** | **String** | A string to filter monitors by name. | [optional] | -| **tags** | **String** | A comma separated list indicating what tags, if any, should be used to filter the list of monitors by scope. For example, `host:host0`. | [optional] | -| **monitor_tags** | **String** | A comma separated list indicating what service and/or custom tags, if any, should be used to filter the list of monitors. Tags created in the Datadog UI automatically have the service key prepended. For example, `service:my-app`. | [optional] | -| **with_downtimes** | **Boolean** | If this argument is set to true, then the returned data includes all current active downtimes for each monitor. | [optional] | -| **id_offset** | **Integer** | Monitor ID offset. | [optional] | -| **page** | **Integer** | The page to start paginating from. If this argument is not specified, the request returns all monitors without pagination. | [optional] | -| **page_size** | **Integer** | The number of monitors to return per page. If the page argument is not specified, the default behavior returns all monitors without a `page_size` limit. However, if page is specified and `page_size` is not, the argument defaults to 100. | [optional] | +| Name | Type | Description | Notes | +| ------------------ | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **group_states** | **String** | When specified, shows additional information about the group states. Choose one or more from `all`, `alert`, `warn`, and `no data`. | [optional] | +| **name** | **String** | A string to filter monitors by name. | [optional] | +| **tags** | **String** | A comma separated list indicating what tags, if any, should be used to filter the list of monitors by scope. For example, `host:host0`. | [optional] | +| **monitor_tags** | **String** | A comma separated list indicating what service and/or custom tags, if any, should be used to filter the list of monitors. Tags created in the Datadog UI automatically have the service key prepended. For example, `service:my-app`. | [optional] | +| **with_downtimes** | **Boolean** | If this argument is set to true, then the returned data includes all current active downtimes for each monitor. | [optional] | +| **id_offset** | **Integer** | Monitor ID offset. | [optional] | +| **page** | **Integer** | The page to start paginating from. If this argument is not specified, the request returns all monitors without pagination. | [optional] | +| **page_size** | **Integer** | The number of monitors to return per page. If the page argument is not specified, the default behavior returns all monitors without a `page_size` limit. However, if page is specified and `page_size` is not, the argument defaults to 100. | [optional] | ### Return type @@ -483,7 +477,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## search_monitor_groups > search_monitor_groups(opts) @@ -531,12 +524,12 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **query** | **String** | After entering a search query in your [Manage Monitor page][1] use the query parameter value in the URL of the page as value for this parameter. Consult the dedicated [manage monitor documentation][2] page to learn more. The query can contain any number of space-separated monitor attributes, for instance `query=\"type:metric status:alert\"`. [1]: https://app.datadoghq.com/monitors/manage [2]: /monitors/manage/#find-the-monitors | [optional] | -| **page** | **Integer** | Page to start paginating from. | [optional][default to 0] | -| **per_page** | **Integer** | Number of monitors to return per page. | [optional][default to 30] | -| **sort** | **String** | String for sort order, composed of field and sort order separate by a comma, e.g. `name,asc`. Supported sort directions: `asc`, `desc`. Supported fields: * `name` * `status` * `tags` | [optional] | +| Name | Type | Description | Notes | +| ------------ | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------- | +| **query** | **String** | After entering a search query in your [Manage Monitor page][1] use the query parameter value in the URL of the page as value for this parameter. Consult the dedicated [manage monitor documentation][2] page to learn more. The query can contain any number of space-separated monitor attributes, for instance `query=\"type:metric status:alert\"`. [1]: https://app.datadoghq.com/monitors/manage [2]: /monitors/manage/#find-the-monitors | [optional] | +| **page** | **Integer** | Page to start paginating from. | [optional][default to 0] | +| **per_page** | **Integer** | Number of monitors to return per page. | [optional][default to 30] | +| **sort** | **String** | String for sort order, composed of field and sort order separate by a comma, e.g. `name,asc`. Supported sort directions: `asc`, `desc`. Supported fields: _ `name` _ `status` \* `tags` | [optional] | ### Return type @@ -551,7 +544,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## search_monitors > search_monitors(opts) @@ -599,12 +591,12 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **query** | **String** | After entering a search query in your [Manage Monitor page][1] use the query parameter value in the URL of the page as value for this parameter. Consult the dedicated [manage monitor documentation][2] page to learn more. The query can contain any number of space-separated monitor attributes, for instance `query=\"type:metric status:alert\"`. [1]: https://app.datadoghq.com/monitors/manage [2]: /monitors/manage/#find-the-monitors | [optional] | -| **page** | **Integer** | Page to start paginating from. | [optional][default to 0] | -| **per_page** | **Integer** | Number of monitors to return per page. | [optional][default to 30] | -| **sort** | **String** | String for sort order, composed of field and sort order separate by a comma, e.g. `name,asc`. Supported sort directions: `asc`, `desc`. Supported fields: * `name` * `status` * `tags` | [optional] | +| Name | Type | Description | Notes | +| ------------ | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------- | +| **query** | **String** | After entering a search query in your [Manage Monitor page][1] use the query parameter value in the URL of the page as value for this parameter. Consult the dedicated [manage monitor documentation][2] page to learn more. The query can contain any number of space-separated monitor attributes, for instance `query=\"type:metric status:alert\"`. [1]: https://app.datadoghq.com/monitors/manage [2]: /monitors/manage/#find-the-monitors | [optional] | +| **page** | **Integer** | Page to start paginating from. | [optional][default to 0] | +| **per_page** | **Integer** | Number of monitors to return per page. | [optional][default to 30] | +| **sort** | **String** | String for sort order, composed of field and sort order separate by a comma, e.g. `name,asc`. Supported sort directions: `asc`, `desc`. Supported fields: _ `name` _ `status` \* `tags` | [optional] | ### Return type @@ -619,7 +611,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## update_monitor > update_monitor(monitor_id, body) @@ -663,10 +654,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **monitor_id** | **Integer** | The ID of the monitor. | | -| **body** | [**MonitorUpdateRequest**](MonitorUpdateRequest.md) | Edit a monitor request body. | | +| Name | Type | Description | Notes | +| -------------- | --------------------------------------------------- | ---------------------------- | ----- | +| **monitor_id** | **Integer** | The ID of the monitor. | | +| **body** | [**MonitorUpdateRequest**](MonitorUpdateRequest.md) | Edit a monitor request body. | | ### Return type @@ -681,7 +672,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## validate_monitor > Object validate_monitor(body) @@ -724,9 +714,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**Monitor**](Monitor.md) | Monitor request object | | +| Name | Type | Description | Notes | +| -------- | ------------------------- | ---------------------- | ----- | +| **body** | [**Monitor**](Monitor.md) | Monitor request object | | ### Return type @@ -740,4 +730,3 @@ end - **Content-Type**: application/json - **Accept**: application/json - diff --git a/docs/v1/NoteWidgetDefinition.md b/docs/v1/NoteWidgetDefinition.md index 92a0c7402d7c..6aea24e1ae24 100644 --- a/docs/v1/NoteWidgetDefinition.md +++ b/docs/v1/NoteWidgetDefinition.md @@ -2,18 +2,18 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **background_color** | **String** | Background color of the note. | [optional] | -| **content** | **String** | Content of the note. | | -| **font_size** | **String** | Size of the text. | [optional] | -| **has_padding** | **Boolean** | Whether to add padding or not. | [optional][default to true] | -| **show_tick** | **Boolean** | Whether to show a tick or not. | [optional] | -| **text_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | -| **tick_edge** | [**WidgetTickEdge**](WidgetTickEdge.md) | | [optional] | -| **tick_pos** | **String** | Where to position the tick on an edge. | [optional] | -| **type** | [**NoteWidgetDefinitionType**](NoteWidgetDefinitionType.md) | | [default to 'note'] | -| **vertical_align** | [**WidgetVerticalAlign**](WidgetVerticalAlign.md) | | [optional] | +| Name | Type | Description | Notes | +| -------------------- | ----------------------------------------------------------- | -------------------------------------- | --------------------------- | +| **background_color** | **String** | Background color of the note. | [optional] | +| **content** | **String** | Content of the note. | | +| **font_size** | **String** | Size of the text. | [optional] | +| **has_padding** | **Boolean** | Whether to add padding or not. | [optional][default to true] | +| **show_tick** | **Boolean** | Whether to show a tick or not. | [optional] | +| **text_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | +| **tick_edge** | [**WidgetTickEdge**](WidgetTickEdge.md) | | [optional] | +| **tick_pos** | **String** | Where to position the tick on an edge. | [optional] | +| **type** | [**NoteWidgetDefinitionType**](NoteWidgetDefinitionType.md) | | [default to 'note'] | +| **vertical_align** | [**WidgetVerticalAlign**](WidgetVerticalAlign.md) | | [optional] | ## Example @@ -33,4 +33,3 @@ instance = DatadogAPIClient::V1::NoteWidgetDefinition.new( vertical_align: null ) ``` - diff --git a/docs/v1/NoteWidgetDefinitionType.md b/docs/v1/NoteWidgetDefinitionType.md index 723f17c3617a..cc04091ee7fa 100644 --- a/docs/v1/NoteWidgetDefinitionType.md +++ b/docs/v1/NoteWidgetDefinitionType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::NoteWidgetDefinitionType.new() ``` - diff --git a/docs/v1/NotebookAbsoluteTime.md b/docs/v1/NotebookAbsoluteTime.md index 628318419418..b0c3fc2dfff5 100644 --- a/docs/v1/NotebookAbsoluteTime.md +++ b/docs/v1/NotebookAbsoluteTime.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **_end** | **Time** | The end time. | | -| **live** | **Boolean** | Indicates whether the timeframe should be shifted to end at the current time. | [optional] | -| **start** | **Time** | The start time. | | +| Name | Type | Description | Notes | +| --------- | ----------- | ----------------------------------------------------------------------------- | ---------- | +| **\_end** | **Time** | The end time. | | +| **live** | **Boolean** | Indicates whether the timeframe should be shifted to end at the current time. | [optional] | +| **start** | **Time** | The start time. | | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::NotebookAbsoluteTime.new( start: 2021-02-24T19:18:28Z ) ``` - diff --git a/docs/v1/NotebookAuthor.md b/docs/v1/NotebookAuthor.md index 0718e347fa37..ae9d3a25280a 100644 --- a/docs/v1/NotebookAuthor.md +++ b/docs/v1/NotebookAuthor.md @@ -2,17 +2,17 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **created_at** | **Time** | Creation time of the user. | [optional] | -| **disabled** | **Boolean** | Whether the user is disabled. | [optional] | -| **email** | **String** | Email of the user. | [optional] | -| **handle** | **String** | Handle of the user. | [optional] | -| **icon** | **String** | URL of the user's icon. | [optional] | -| **name** | **String** | Name of the user. | [optional] | -| **status** | **String** | Status of the user. | [optional] | -| **title** | **String** | Title of the user. | [optional] | -| **verified** | **Boolean** | Whether the user is verified. | [optional] | +| Name | Type | Description | Notes | +| -------------- | ----------- | ----------------------------- | ---------- | +| **created_at** | **Time** | Creation time of the user. | [optional] | +| **disabled** | **Boolean** | Whether the user is disabled. | [optional] | +| **email** | **String** | Email of the user. | [optional] | +| **handle** | **String** | Handle of the user. | [optional] | +| **icon** | **String** | URL of the user's icon. | [optional] | +| **name** | **String** | Name of the user. | [optional] | +| **status** | **String** | Status of the user. | [optional] | +| **title** | **String** | Title of the user. | [optional] | +| **verified** | **Boolean** | Whether the user is verified. | [optional] | ## Example @@ -31,4 +31,3 @@ instance = DatadogAPIClient::V1::NotebookAuthor.new( verified: null ) ``` - diff --git a/docs/v1/NotebookCellCreateRequest.md b/docs/v1/NotebookCellCreateRequest.md index becb932d82df..0d63a46a0fba 100644 --- a/docs/v1/NotebookCellCreateRequest.md +++ b/docs/v1/NotebookCellCreateRequest.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**NotebookCellCreateRequestAttributes**](NotebookCellCreateRequestAttributes.md) | | | -| **type** | [**NotebookCellResourceType**](NotebookCellResourceType.md) | | [default to 'notebook_cells'] | +| Name | Type | Description | Notes | +| -------------- | --------------------------------------------------------------------------------- | ----------- | ------------------------------------- | +| **attributes** | [**NotebookCellCreateRequestAttributes**](NotebookCellCreateRequestAttributes.md) | | | +| **type** | [**NotebookCellResourceType**](NotebookCellResourceType.md) | | [default to 'notebook_cells'] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::NotebookCellCreateRequest.new( type: null ) ``` - diff --git a/docs/v1/NotebookCellCreateRequestAttributes.md b/docs/v1/NotebookCellCreateRequestAttributes.md index 54f1434371fe..2d1438206af3 100644 --- a/docs/v1/NotebookCellCreateRequestAttributes.md +++ b/docs/v1/NotebookCellCreateRequestAttributes.md @@ -41,8 +41,8 @@ DatadogAPIClient::V1::NotebookCellCreateRequestAttributes.build(data_that_doesnt #### Parameters -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| -------- | --------- | -------------------------------------------------- | | **data** | **Mixed** | data to be matched against the list of oneOf items | #### Return type @@ -54,4 +54,3 @@ DatadogAPIClient::V1::NotebookCellCreateRequestAttributes.build(data_that_doesnt - `NotebookTimeseriesCellAttributes` - `NotebookToplistCellAttributes` - `nil` (if no type matches) - diff --git a/docs/v1/NotebookCellResourceType.md b/docs/v1/NotebookCellResourceType.md index 5b96cb9b8011..965656a8eacc 100644 --- a/docs/v1/NotebookCellResourceType.md +++ b/docs/v1/NotebookCellResourceType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::NotebookCellResourceType.new() ``` - diff --git a/docs/v1/NotebookCellResponse.md b/docs/v1/NotebookCellResponse.md index cee59efb9331..d303bfcfe12f 100644 --- a/docs/v1/NotebookCellResponse.md +++ b/docs/v1/NotebookCellResponse.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**NotebookCellResponseAttributes**](NotebookCellResponseAttributes.md) | | | -| **id** | **String** | Notebook cell ID. | | -| **type** | [**NotebookCellResourceType**](NotebookCellResourceType.md) | | [default to 'notebook_cells'] | +| Name | Type | Description | Notes | +| -------------- | ----------------------------------------------------------------------- | ----------------- | ------------------------------------- | +| **attributes** | [**NotebookCellResponseAttributes**](NotebookCellResponseAttributes.md) | | | +| **id** | **String** | Notebook cell ID. | | +| **type** | [**NotebookCellResourceType**](NotebookCellResourceType.md) | | [default to 'notebook_cells'] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::NotebookCellResponse.new( type: null ) ``` - diff --git a/docs/v1/NotebookCellResponseAttributes.md b/docs/v1/NotebookCellResponseAttributes.md index a85a703e3264..9736cfacb63d 100644 --- a/docs/v1/NotebookCellResponseAttributes.md +++ b/docs/v1/NotebookCellResponseAttributes.md @@ -41,8 +41,8 @@ DatadogAPIClient::V1::NotebookCellResponseAttributes.build(data_that_doesnt_matc #### Parameters -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| -------- | --------- | -------------------------------------------------- | | **data** | **Mixed** | data to be matched against the list of oneOf items | #### Return type @@ -54,4 +54,3 @@ DatadogAPIClient::V1::NotebookCellResponseAttributes.build(data_that_doesnt_matc - `NotebookTimeseriesCellAttributes` - `NotebookToplistCellAttributes` - `nil` (if no type matches) - diff --git a/docs/v1/NotebookCellTime.md b/docs/v1/NotebookCellTime.md index 80a2c7764e8d..daac539819ee 100644 --- a/docs/v1/NotebookCellTime.md +++ b/docs/v1/NotebookCellTime.md @@ -37,8 +37,8 @@ DatadogAPIClient::V1::NotebookCellTime.build(data_that_doesnt_match) #### Parameters -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| -------- | --------- | -------------------------------------------------- | | **data** | **Mixed** | data to be matched against the list of oneOf items | #### Return type @@ -46,4 +46,3 @@ DatadogAPIClient::V1::NotebookCellTime.build(data_that_doesnt_match) - `NotebookAbsoluteTime` - `NotebookRelativeTime` - `nil` (if no type matches) - diff --git a/docs/v1/NotebookCellUpdateRequest.md b/docs/v1/NotebookCellUpdateRequest.md index 258b3990d95a..182dd23b2967 100644 --- a/docs/v1/NotebookCellUpdateRequest.md +++ b/docs/v1/NotebookCellUpdateRequest.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**NotebookCellUpdateRequestAttributes**](NotebookCellUpdateRequestAttributes.md) | | | -| **id** | **String** | Notebook cell ID. | | -| **type** | [**NotebookCellResourceType**](NotebookCellResourceType.md) | | [default to 'notebook_cells'] | +| Name | Type | Description | Notes | +| -------------- | --------------------------------------------------------------------------------- | ----------------- | ------------------------------------- | +| **attributes** | [**NotebookCellUpdateRequestAttributes**](NotebookCellUpdateRequestAttributes.md) | | | +| **id** | **String** | Notebook cell ID. | | +| **type** | [**NotebookCellResourceType**](NotebookCellResourceType.md) | | [default to 'notebook_cells'] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::NotebookCellUpdateRequest.new( type: null ) ``` - diff --git a/docs/v1/NotebookCellUpdateRequestAttributes.md b/docs/v1/NotebookCellUpdateRequestAttributes.md index 41a84b860363..50a6dd6f45ef 100644 --- a/docs/v1/NotebookCellUpdateRequestAttributes.md +++ b/docs/v1/NotebookCellUpdateRequestAttributes.md @@ -41,8 +41,8 @@ DatadogAPIClient::V1::NotebookCellUpdateRequestAttributes.build(data_that_doesnt #### Parameters -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| -------- | --------- | -------------------------------------------------- | | **data** | **Mixed** | data to be matched against the list of oneOf items | #### Return type @@ -54,4 +54,3 @@ DatadogAPIClient::V1::NotebookCellUpdateRequestAttributes.build(data_that_doesnt - `NotebookTimeseriesCellAttributes` - `NotebookToplistCellAttributes` - `nil` (if no type matches) - diff --git a/docs/v1/NotebookCreateData.md b/docs/v1/NotebookCreateData.md index 813eb0e62e60..657263b5c60c 100644 --- a/docs/v1/NotebookCreateData.md +++ b/docs/v1/NotebookCreateData.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**NotebookCreateDataAttributes**](NotebookCreateDataAttributes.md) | | | -| **type** | [**NotebookResourceType**](NotebookResourceType.md) | | [default to 'notebooks'] | +| Name | Type | Description | Notes | +| -------------- | ------------------------------------------------------------------- | ----------- | -------------------------------- | +| **attributes** | [**NotebookCreateDataAttributes**](NotebookCreateDataAttributes.md) | | | +| **type** | [**NotebookResourceType**](NotebookResourceType.md) | | [default to 'notebooks'] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::NotebookCreateData.new( type: null ) ``` - diff --git a/docs/v1/NotebookCreateDataAttributes.md b/docs/v1/NotebookCreateDataAttributes.md index 331c1e8de029..adbed9d7eb7a 100644 --- a/docs/v1/NotebookCreateDataAttributes.md +++ b/docs/v1/NotebookCreateDataAttributes.md @@ -2,13 +2,13 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **cells** | [**Array<NotebookCellCreateRequest>**](NotebookCellCreateRequest.md) | List of cells to display in the notebook. | | -| **metadata** | [**NotebookMetadata**](NotebookMetadata.md) | | [optional] | -| **name** | **String** | The name of the notebook. | | -| **status** | [**NotebookStatus**](NotebookStatus.md) | | [optional][default to 'published'] | -| **time** | [**NotebookGlobalTime**](NotebookGlobalTime.md) | | | +| Name | Type | Description | Notes | +| ------------ | -------------------------------------------------------------------------- | ----------------------------------------- | ------------------------------------------ | +| **cells** | [**Array<NotebookCellCreateRequest>**](NotebookCellCreateRequest.md) | List of cells to display in the notebook. | | +| **metadata** | [**NotebookMetadata**](NotebookMetadata.md) | | [optional] | +| **name** | **String** | The name of the notebook. | | +| **status** | [**NotebookStatus**](NotebookStatus.md) | | [optional][default to 'published'] | +| **time** | [**NotebookGlobalTime**](NotebookGlobalTime.md) | | | ## Example @@ -23,4 +23,3 @@ instance = DatadogAPIClient::V1::NotebookCreateDataAttributes.new( time: null ) ``` - diff --git a/docs/v1/NotebookCreateRequest.md b/docs/v1/NotebookCreateRequest.md index 69006841d946..f5af87ce709c 100644 --- a/docs/v1/NotebookCreateRequest.md +++ b/docs/v1/NotebookCreateRequest.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**NotebookCreateData**](NotebookCreateData.md) | | | +| Name | Type | Description | Notes | +| -------- | ----------------------------------------------- | ----------- | ----- | +| **data** | [**NotebookCreateData**](NotebookCreateData.md) | | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::NotebookCreateRequest.new( data: null ) ``` - diff --git a/docs/v1/NotebookDistributionCellAttributes.md b/docs/v1/NotebookDistributionCellAttributes.md index da002697fe69..072e5396eebd 100644 --- a/docs/v1/NotebookDistributionCellAttributes.md +++ b/docs/v1/NotebookDistributionCellAttributes.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **definition** | [**DistributionWidgetDefinition**](DistributionWidgetDefinition.md) | | | -| **graph_size** | [**NotebookGraphSize**](NotebookGraphSize.md) | | [optional] | -| **split_by** | [**NotebookSplitBy**](NotebookSplitBy.md) | | [optional] | -| **time** | [**NotebookCellTime**](NotebookCellTime.md) | | [optional] | +| Name | Type | Description | Notes | +| -------------- | ------------------------------------------------------------------- | ----------- | ---------- | +| **definition** | [**DistributionWidgetDefinition**](DistributionWidgetDefinition.md) | | | +| **graph_size** | [**NotebookGraphSize**](NotebookGraphSize.md) | | [optional] | +| **split_by** | [**NotebookSplitBy**](NotebookSplitBy.md) | | [optional] | +| **time** | [**NotebookCellTime**](NotebookCellTime.md) | | [optional] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V1::NotebookDistributionCellAttributes.new( time: null ) ``` - diff --git a/docs/v1/NotebookGlobalTime.md b/docs/v1/NotebookGlobalTime.md index b546dad93020..7b1563b7a5f3 100644 --- a/docs/v1/NotebookGlobalTime.md +++ b/docs/v1/NotebookGlobalTime.md @@ -37,8 +37,8 @@ DatadogAPIClient::V1::NotebookGlobalTime.build(data_that_doesnt_match) #### Parameters -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| -------- | --------- | -------------------------------------------------- | | **data** | **Mixed** | data to be matched against the list of oneOf items | #### Return type @@ -46,4 +46,3 @@ DatadogAPIClient::V1::NotebookGlobalTime.build(data_that_doesnt_match) - `NotebookAbsoluteTime` - `NotebookRelativeTime` - `nil` (if no type matches) - diff --git a/docs/v1/NotebookGraphSize.md b/docs/v1/NotebookGraphSize.md index bc26070e1ba0..4e9be111116b 100644 --- a/docs/v1/NotebookGraphSize.md +++ b/docs/v1/NotebookGraphSize.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::NotebookGraphSize.new() ``` - diff --git a/docs/v1/NotebookHeatMapCellAttributes.md b/docs/v1/NotebookHeatMapCellAttributes.md index 5b276cc0a923..4c0b5f610895 100644 --- a/docs/v1/NotebookHeatMapCellAttributes.md +++ b/docs/v1/NotebookHeatMapCellAttributes.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **definition** | [**HeatMapWidgetDefinition**](HeatMapWidgetDefinition.md) | | | -| **graph_size** | [**NotebookGraphSize**](NotebookGraphSize.md) | | [optional] | -| **split_by** | [**NotebookSplitBy**](NotebookSplitBy.md) | | [optional] | -| **time** | [**NotebookCellTime**](NotebookCellTime.md) | | [optional] | +| Name | Type | Description | Notes | +| -------------- | --------------------------------------------------------- | ----------- | ---------- | +| **definition** | [**HeatMapWidgetDefinition**](HeatMapWidgetDefinition.md) | | | +| **graph_size** | [**NotebookGraphSize**](NotebookGraphSize.md) | | [optional] | +| **split_by** | [**NotebookSplitBy**](NotebookSplitBy.md) | | [optional] | +| **time** | [**NotebookCellTime**](NotebookCellTime.md) | | [optional] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V1::NotebookHeatMapCellAttributes.new( time: null ) ``` - diff --git a/docs/v1/NotebookLogStreamCellAttributes.md b/docs/v1/NotebookLogStreamCellAttributes.md index fdccbaf2037b..70ff48e97a32 100644 --- a/docs/v1/NotebookLogStreamCellAttributes.md +++ b/docs/v1/NotebookLogStreamCellAttributes.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **definition** | [**LogStreamWidgetDefinition**](LogStreamWidgetDefinition.md) | | | -| **graph_size** | [**NotebookGraphSize**](NotebookGraphSize.md) | | [optional] | -| **time** | [**NotebookCellTime**](NotebookCellTime.md) | | [optional] | +| Name | Type | Description | Notes | +| -------------- | ------------------------------------------------------------- | ----------- | ---------- | +| **definition** | [**LogStreamWidgetDefinition**](LogStreamWidgetDefinition.md) | | | +| **graph_size** | [**NotebookGraphSize**](NotebookGraphSize.md) | | [optional] | +| **time** | [**NotebookCellTime**](NotebookCellTime.md) | | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::NotebookLogStreamCellAttributes.new( time: null ) ``` - diff --git a/docs/v1/NotebookMarkdownCellAttributes.md b/docs/v1/NotebookMarkdownCellAttributes.md index 5500687482a2..a45dd10ce453 100644 --- a/docs/v1/NotebookMarkdownCellAttributes.md +++ b/docs/v1/NotebookMarkdownCellAttributes.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **definition** | [**NotebookMarkdownCellDefinition**](NotebookMarkdownCellDefinition.md) | | | +| Name | Type | Description | Notes | +| -------------- | ----------------------------------------------------------------------- | ----------- | ----- | +| **definition** | [**NotebookMarkdownCellDefinition**](NotebookMarkdownCellDefinition.md) | | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::NotebookMarkdownCellAttributes.new( definition: null ) ``` - diff --git a/docs/v1/NotebookMarkdownCellDefinition.md b/docs/v1/NotebookMarkdownCellDefinition.md index c7fd03cc9864..6152b010a5ac 100644 --- a/docs/v1/NotebookMarkdownCellDefinition.md +++ b/docs/v1/NotebookMarkdownCellDefinition.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **text** | **String** | The markdown content. | | -| **type** | [**NotebookMarkdownCellDefinitionType**](NotebookMarkdownCellDefinitionType.md) | | [default to 'markdown'] | +| Name | Type | Description | Notes | +| -------- | ------------------------------------------------------------------------------- | --------------------- | ------------------------------- | +| **text** | **String** | The markdown content. | | +| **type** | [**NotebookMarkdownCellDefinitionType**](NotebookMarkdownCellDefinitionType.md) | | [default to 'markdown'] | ## Example @@ -13,9 +13,8 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::NotebookMarkdownCellDefinition.new( - text: # Example Header + text: # Example Header example content, type: null ) ``` - diff --git a/docs/v1/NotebookMarkdownCellDefinitionType.md b/docs/v1/NotebookMarkdownCellDefinitionType.md index 9496f2eb085d..0988b1a22002 100644 --- a/docs/v1/NotebookMarkdownCellDefinitionType.md +++ b/docs/v1/NotebookMarkdownCellDefinitionType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::NotebookMarkdownCellDefinitionType.new() ``` - diff --git a/docs/v1/NotebookMetadata.md b/docs/v1/NotebookMetadata.md index 99561669c895..bfef3e826430 100644 --- a/docs/v1/NotebookMetadata.md +++ b/docs/v1/NotebookMetadata.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **is_template** | **Boolean** | Whether or not the notebook is a template. | [optional][default to false] | -| **take_snapshots** | **Boolean** | Whether or not the notebook takes snapshot image backups of the notebook's fixed-time graphs. | [optional][default to false] | -| **type** | [**NotebookMetadataType**](NotebookMetadataType.md) | | [optional][default to 'null'] | +| Name | Type | Description | Notes | +| ------------------ | --------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------- | +| **is_template** | **Boolean** | Whether or not the notebook is a template. | [optional][default to false] | +| **take_snapshots** | **Boolean** | Whether or not the notebook takes snapshot image backups of the notebook's fixed-time graphs. | [optional][default to false] | +| **type** | [**NotebookMetadataType**](NotebookMetadataType.md) | | [optional][default to 'null'] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::NotebookMetadata.new( type: null ) ``` - diff --git a/docs/v1/NotebookMetadataType.md b/docs/v1/NotebookMetadataType.md index 729e5088498e..c304af24d8ee 100644 --- a/docs/v1/NotebookMetadataType.md +++ b/docs/v1/NotebookMetadataType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::NotebookMetadataType.new() ``` - diff --git a/docs/v1/NotebookRelativeTime.md b/docs/v1/NotebookRelativeTime.md index ae2ee096804f..0e1a91b9372a 100644 --- a/docs/v1/NotebookRelativeTime.md +++ b/docs/v1/NotebookRelativeTime.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **live_span** | [**WidgetLiveSpan**](WidgetLiveSpan.md) | | | +| Name | Type | Description | Notes | +| ------------- | --------------------------------------- | ----------- | ----- | +| **live_span** | [**WidgetLiveSpan**](WidgetLiveSpan.md) | | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::NotebookRelativeTime.new( live_span: null ) ``` - diff --git a/docs/v1/NotebookResourceType.md b/docs/v1/NotebookResourceType.md index e6de8d2e774a..4959f0088853 100644 --- a/docs/v1/NotebookResourceType.md +++ b/docs/v1/NotebookResourceType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::NotebookResourceType.new() ``` - diff --git a/docs/v1/NotebookResponse.md b/docs/v1/NotebookResponse.md index b7aa61a06d96..6378454f5068 100644 --- a/docs/v1/NotebookResponse.md +++ b/docs/v1/NotebookResponse.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**NotebookResponseData**](NotebookResponseData.md) | | [optional] | +| Name | Type | Description | Notes | +| -------- | --------------------------------------------------- | ----------- | ---------- | +| **data** | [**NotebookResponseData**](NotebookResponseData.md) | | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::NotebookResponse.new( data: null ) ``` - diff --git a/docs/v1/NotebookResponseData.md b/docs/v1/NotebookResponseData.md index d593995c5986..6cdbeef292b6 100644 --- a/docs/v1/NotebookResponseData.md +++ b/docs/v1/NotebookResponseData.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**NotebookResponseDataAttributes**](NotebookResponseDataAttributes.md) | | | -| **id** | **Integer** | Unique notebook ID, assigned when you create the notebook. | [readonly] | -| **type** | [**NotebookResourceType**](NotebookResourceType.md) | | [default to 'notebooks'] | +| Name | Type | Description | Notes | +| -------------- | ----------------------------------------------------------------------- | ---------------------------------------------------------- | -------------------------------- | +| **attributes** | [**NotebookResponseDataAttributes**](NotebookResponseDataAttributes.md) | | | +| **id** | **Integer** | Unique notebook ID, assigned when you create the notebook. | [readonly] | +| **type** | [**NotebookResourceType**](NotebookResourceType.md) | | [default to 'notebooks'] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::NotebookResponseData.new( type: null ) ``` - diff --git a/docs/v1/NotebookResponseDataAttributes.md b/docs/v1/NotebookResponseDataAttributes.md index 9bcc021ad38d..45223944a23c 100644 --- a/docs/v1/NotebookResponseDataAttributes.md +++ b/docs/v1/NotebookResponseDataAttributes.md @@ -2,16 +2,16 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **author** | [**NotebookAuthor**](NotebookAuthor.md) | | [optional] | -| **cells** | [**Array<NotebookCellResponse>**](NotebookCellResponse.md) | List of cells to display in the notebook. | | -| **created** | **Time** | UTC time stamp for when the notebook was created. | [optional][readonly] | -| **metadata** | [**NotebookMetadata**](NotebookMetadata.md) | | [optional] | -| **modified** | **Time** | UTC time stamp for when the notebook was last modified. | [optional][readonly] | -| **name** | **String** | The name of the notebook. | | -| **status** | [**NotebookStatus**](NotebookStatus.md) | | [optional][default to 'published'] | -| **time** | [**NotebookGlobalTime**](NotebookGlobalTime.md) | | | +| Name | Type | Description | Notes | +| ------------ | ---------------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------ | +| **author** | [**NotebookAuthor**](NotebookAuthor.md) | | [optional] | +| **cells** | [**Array<NotebookCellResponse>**](NotebookCellResponse.md) | List of cells to display in the notebook. | | +| **created** | **Time** | UTC time stamp for when the notebook was created. | [optional][readonly] | +| **metadata** | [**NotebookMetadata**](NotebookMetadata.md) | | [optional] | +| **modified** | **Time** | UTC time stamp for when the notebook was last modified. | [optional][readonly] | +| **name** | **String** | The name of the notebook. | | +| **status** | [**NotebookStatus**](NotebookStatus.md) | | [optional][default to 'published'] | +| **time** | [**NotebookGlobalTime**](NotebookGlobalTime.md) | | | ## Example @@ -29,4 +29,3 @@ instance = DatadogAPIClient::V1::NotebookResponseDataAttributes.new( time: null ) ``` - diff --git a/docs/v1/NotebookSplitBy.md b/docs/v1/NotebookSplitBy.md index 2555e3e79693..8b5868022310 100644 --- a/docs/v1/NotebookSplitBy.md +++ b/docs/v1/NotebookSplitBy.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **keys** | **Array<String>** | Keys to split on. | | -| **tags** | **Array<String>** | Tags to split on. | | +| Name | Type | Description | Notes | +| -------- | ----------------------- | ----------------- | ----- | +| **keys** | **Array<String>** | Keys to split on. | | +| **tags** | **Array<String>** | Tags to split on. | | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::NotebookSplitBy.new( tags: null ) ``` - diff --git a/docs/v1/NotebookStatus.md b/docs/v1/NotebookStatus.md index b53bd1416236..f5e922ff719e 100644 --- a/docs/v1/NotebookStatus.md +++ b/docs/v1/NotebookStatus.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::NotebookStatus.new() ``` - diff --git a/docs/v1/NotebookTimeseriesCellAttributes.md b/docs/v1/NotebookTimeseriesCellAttributes.md index 108988b86668..8ef033121650 100644 --- a/docs/v1/NotebookTimeseriesCellAttributes.md +++ b/docs/v1/NotebookTimeseriesCellAttributes.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **definition** | [**TimeseriesWidgetDefinition**](TimeseriesWidgetDefinition.md) | | | -| **graph_size** | [**NotebookGraphSize**](NotebookGraphSize.md) | | [optional] | -| **split_by** | [**NotebookSplitBy**](NotebookSplitBy.md) | | [optional] | -| **time** | [**NotebookCellTime**](NotebookCellTime.md) | | [optional] | +| Name | Type | Description | Notes | +| -------------- | --------------------------------------------------------------- | ----------- | ---------- | +| **definition** | [**TimeseriesWidgetDefinition**](TimeseriesWidgetDefinition.md) | | | +| **graph_size** | [**NotebookGraphSize**](NotebookGraphSize.md) | | [optional] | +| **split_by** | [**NotebookSplitBy**](NotebookSplitBy.md) | | [optional] | +| **time** | [**NotebookCellTime**](NotebookCellTime.md) | | [optional] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V1::NotebookTimeseriesCellAttributes.new( time: null ) ``` - diff --git a/docs/v1/NotebookToplistCellAttributes.md b/docs/v1/NotebookToplistCellAttributes.md index dc6d7292a3b0..e8bf9abd9297 100644 --- a/docs/v1/NotebookToplistCellAttributes.md +++ b/docs/v1/NotebookToplistCellAttributes.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **definition** | [**ToplistWidgetDefinition**](ToplistWidgetDefinition.md) | | | -| **graph_size** | [**NotebookGraphSize**](NotebookGraphSize.md) | | [optional] | -| **split_by** | [**NotebookSplitBy**](NotebookSplitBy.md) | | [optional] | -| **time** | [**NotebookCellTime**](NotebookCellTime.md) | | [optional] | +| Name | Type | Description | Notes | +| -------------- | --------------------------------------------------------- | ----------- | ---------- | +| **definition** | [**ToplistWidgetDefinition**](ToplistWidgetDefinition.md) | | | +| **graph_size** | [**NotebookGraphSize**](NotebookGraphSize.md) | | [optional] | +| **split_by** | [**NotebookSplitBy**](NotebookSplitBy.md) | | [optional] | +| **time** | [**NotebookCellTime**](NotebookCellTime.md) | | [optional] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V1::NotebookToplistCellAttributes.new( time: null ) ``` - diff --git a/docs/v1/NotebookUpdateCell.md b/docs/v1/NotebookUpdateCell.md index 981c0be8804f..b967ab5738d4 100644 --- a/docs/v1/NotebookUpdateCell.md +++ b/docs/v1/NotebookUpdateCell.md @@ -37,8 +37,8 @@ DatadogAPIClient::V1::NotebookUpdateCell.build(data_that_doesnt_match) #### Parameters -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| -------- | --------- | -------------------------------------------------- | | **data** | **Mixed** | data to be matched against the list of oneOf items | #### Return type @@ -46,4 +46,3 @@ DatadogAPIClient::V1::NotebookUpdateCell.build(data_that_doesnt_match) - `NotebookCellCreateRequest` - `NotebookCellUpdateRequest` - `nil` (if no type matches) - diff --git a/docs/v1/NotebookUpdateData.md b/docs/v1/NotebookUpdateData.md index d903bcfec71b..8048c070327a 100644 --- a/docs/v1/NotebookUpdateData.md +++ b/docs/v1/NotebookUpdateData.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**NotebookUpdateDataAttributes**](NotebookUpdateDataAttributes.md) | | | -| **type** | [**NotebookResourceType**](NotebookResourceType.md) | | [default to 'notebooks'] | +| Name | Type | Description | Notes | +| -------------- | ------------------------------------------------------------------- | ----------- | -------------------------------- | +| **attributes** | [**NotebookUpdateDataAttributes**](NotebookUpdateDataAttributes.md) | | | +| **type** | [**NotebookResourceType**](NotebookResourceType.md) | | [default to 'notebooks'] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::NotebookUpdateData.new( type: null ) ``` - diff --git a/docs/v1/NotebookUpdateDataAttributes.md b/docs/v1/NotebookUpdateDataAttributes.md index 1ab9ae39bd19..1d03961d6367 100644 --- a/docs/v1/NotebookUpdateDataAttributes.md +++ b/docs/v1/NotebookUpdateDataAttributes.md @@ -2,13 +2,13 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **cells** | [**Array<NotebookUpdateCell>**](NotebookUpdateCell.md) | List of cells to display in the notebook. | | -| **metadata** | [**NotebookMetadata**](NotebookMetadata.md) | | [optional] | -| **name** | **String** | The name of the notebook. | | -| **status** | [**NotebookStatus**](NotebookStatus.md) | | [optional][default to 'published'] | -| **time** | [**NotebookGlobalTime**](NotebookGlobalTime.md) | | | +| Name | Type | Description | Notes | +| ------------ | ------------------------------------------------------------ | ----------------------------------------- | ------------------------------------------ | +| **cells** | [**Array<NotebookUpdateCell>**](NotebookUpdateCell.md) | List of cells to display in the notebook. | | +| **metadata** | [**NotebookMetadata**](NotebookMetadata.md) | | [optional] | +| **name** | **String** | The name of the notebook. | | +| **status** | [**NotebookStatus**](NotebookStatus.md) | | [optional][default to 'published'] | +| **time** | [**NotebookGlobalTime**](NotebookGlobalTime.md) | | | ## Example @@ -23,4 +23,3 @@ instance = DatadogAPIClient::V1::NotebookUpdateDataAttributes.new( time: null ) ``` - diff --git a/docs/v1/NotebookUpdateRequest.md b/docs/v1/NotebookUpdateRequest.md index cf0577c821a4..d1dfd1a7221e 100644 --- a/docs/v1/NotebookUpdateRequest.md +++ b/docs/v1/NotebookUpdateRequest.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**NotebookUpdateData**](NotebookUpdateData.md) | | | +| Name | Type | Description | Notes | +| -------- | ----------------------------------------------- | ----------- | ----- | +| **data** | [**NotebookUpdateData**](NotebookUpdateData.md) | | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::NotebookUpdateRequest.new( data: null ) ``` - diff --git a/docs/v1/NotebooksAPI.md b/docs/v1/NotebooksAPI.md index 9dd0ad1ec9b7..d751b9cac85c 100644 --- a/docs/v1/NotebooksAPI.md +++ b/docs/v1/NotebooksAPI.md @@ -2,14 +2,13 @@ All URIs are relative to *https://api.datadoghq.com* -| Method | HTTP request | Description | -| ------ | ------------ | ----------- | -| [**create_notebook**](NotebooksAPI.md#create_notebook) | **POST** /api/v1/notebooks | Create a notebook | +| Method | HTTP request | Description | +| ------------------------------------------------------ | ------------------------------------------ | ----------------- | +| [**create_notebook**](NotebooksAPI.md#create_notebook) | **POST** /api/v1/notebooks | Create a notebook | | [**delete_notebook**](NotebooksAPI.md#delete_notebook) | **DELETE** /api/v1/notebooks/{notebook_id} | Delete a notebook | -| [**get_notebook**](NotebooksAPI.md#get_notebook) | **GET** /api/v1/notebooks/{notebook_id} | Get a notebook | -| [**list_notebooks**](NotebooksAPI.md#list_notebooks) | **GET** /api/v1/notebooks | Get all notebooks | -| [**update_notebook**](NotebooksAPI.md#update_notebook) | **PUT** /api/v1/notebooks/{notebook_id} | Update a notebook | - +| [**get_notebook**](NotebooksAPI.md#get_notebook) | **GET** /api/v1/notebooks/{notebook_id} | Get a notebook | +| [**list_notebooks**](NotebooksAPI.md#list_notebooks) | **GET** /api/v1/notebooks | Get all notebooks | +| [**update_notebook**](NotebooksAPI.md#update_notebook) | **PUT** /api/v1/notebooks/{notebook_id} | Update a notebook | ## create_notebook @@ -53,9 +52,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**NotebookCreateRequest**](NotebookCreateRequest.md) | The JSON description of the notebook you want to create. | | +| Name | Type | Description | Notes | +| -------- | ----------------------------------------------------- | -------------------------------------------------------- | ----- | +| **body** | [**NotebookCreateRequest**](NotebookCreateRequest.md) | The JSON description of the notebook you want to create. | | ### Return type @@ -70,7 +69,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## delete_notebook > delete_notebook(notebook_id) @@ -112,9 +110,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **notebook_id** | **Integer** | Unique ID, assigned when you create the notebook. | | +| Name | Type | Description | Notes | +| --------------- | ----------- | ------------------------------------------------- | ----- | +| **notebook_id** | **Integer** | Unique ID, assigned when you create the notebook. | | ### Return type @@ -129,7 +127,6 @@ nil (empty response body) - **Content-Type**: Not defined - **Accept**: application/json - ## get_notebook > get_notebook(notebook_id) @@ -172,9 +169,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **notebook_id** | **Integer** | Unique ID, assigned when you create the notebook. | | +| Name | Type | Description | Notes | +| --------------- | ----------- | ------------------------------------------------- | ----- | +| **notebook_id** | **Integer** | Unique ID, assigned when you create the notebook. | | ### Return type @@ -189,7 +186,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## list_notebooks > list_notebooks(opts) @@ -244,18 +240,18 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **author_handle** | **String** | Return notebooks created by the given `author_handle`. | [optional] | -| **exclude_author_handle** | **String** | Return notebooks not created by the given `author_handle`. | [optional] | -| **start** | **Integer** | The index of the first notebook you want returned. | [optional] | -| **count** | **Integer** | The number of notebooks to be returned. | [optional] | -| **sort_field** | **String** | Sort by field `modified`, `name`, or `created`. | [optional][default to 'modified'] | -| **sort_dir** | **String** | Sort by direction `asc` or `desc`. | [optional][default to 'desc'] | -| **query** | **String** | Return only notebooks with `query` string in notebook name or author handle. | [optional] | -| **include_cells** | **Boolean** | Value of `false` excludes the `cells` and global `time` for each notebook. | [optional][default to true] | -| **is_template** | **Boolean** | True value returns only template notebooks. Default is false (returns only non-template notebooks). | [optional][default to false] | -| **type** | **String** | If type is provided, returns only notebooks with that metadata type. Default does not have type filtering. | [optional] | +| Name | Type | Description | Notes | +| ------------------------- | ----------- | ---------------------------------------------------------------------------------------------------------- | ----------------------------------------- | +| **author_handle** | **String** | Return notebooks created by the given `author_handle`. | [optional] | +| **exclude_author_handle** | **String** | Return notebooks not created by the given `author_handle`. | [optional] | +| **start** | **Integer** | The index of the first notebook you want returned. | [optional] | +| **count** | **Integer** | The number of notebooks to be returned. | [optional] | +| **sort_field** | **String** | Sort by field `modified`, `name`, or `created`. | [optional][default to 'modified'] | +| **sort_dir** | **String** | Sort by direction `asc` or `desc`. | [optional][default to 'desc'] | +| **query** | **String** | Return only notebooks with `query` string in notebook name or author handle. | [optional] | +| **include_cells** | **Boolean** | Value of `false` excludes the `cells` and global `time` for each notebook. | [optional][default to true] | +| **is_template** | **Boolean** | True value returns only template notebooks. Default is false (returns only non-template notebooks). | [optional][default to false] | +| **type** | **String** | If type is provided, returns only notebooks with that metadata type. Default does not have type filtering. | [optional] | ### Return type @@ -270,7 +266,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## update_notebook > update_notebook(notebook_id, body) @@ -314,10 +309,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **notebook_id** | **Integer** | Unique ID, assigned when you create the notebook. | | -| **body** | [**NotebookUpdateRequest**](NotebookUpdateRequest.md) | Update notebook request body. | | +| Name | Type | Description | Notes | +| --------------- | ----------------------------------------------------- | ------------------------------------------------- | ----- | +| **notebook_id** | **Integer** | Unique ID, assigned when you create the notebook. | | +| **body** | [**NotebookUpdateRequest**](NotebookUpdateRequest.md) | Update notebook request body. | | ### Return type @@ -331,4 +326,3 @@ end - **Content-Type**: application/json - **Accept**: application/json - diff --git a/docs/v1/NotebooksResponse.md b/docs/v1/NotebooksResponse.md index f503af400571..d33cbad5e8c6 100644 --- a/docs/v1/NotebooksResponse.md +++ b/docs/v1/NotebooksResponse.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| -------- | ------------------------------------------------------------------ | ----------------------------- | ---------- | | **data** | [**Array<NotebooksResponseData>**](NotebooksResponseData.md) | List of notebook definitions. | [optional] | -| **meta** | [**NotebooksResponseMeta**](NotebooksResponseMeta.md) | | [optional] | +| **meta** | [**NotebooksResponseMeta**](NotebooksResponseMeta.md) | | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::NotebooksResponse.new( meta: null ) ``` - diff --git a/docs/v1/NotebooksResponseData.md b/docs/v1/NotebooksResponseData.md index 547b93fb4fa1..89e3b607ece0 100644 --- a/docs/v1/NotebooksResponseData.md +++ b/docs/v1/NotebooksResponseData.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**NotebooksResponseDataAttributes**](NotebooksResponseDataAttributes.md) | | | -| **id** | **Integer** | Unique notebook ID, assigned when you create the notebook. | [readonly] | -| **type** | [**NotebookResourceType**](NotebookResourceType.md) | | [default to 'notebooks'] | +| Name | Type | Description | Notes | +| -------------- | ------------------------------------------------------------------------- | ---------------------------------------------------------- | -------------------------------- | +| **attributes** | [**NotebooksResponseDataAttributes**](NotebooksResponseDataAttributes.md) | | | +| **id** | **Integer** | Unique notebook ID, assigned when you create the notebook. | [readonly] | +| **type** | [**NotebookResourceType**](NotebookResourceType.md) | | [default to 'notebooks'] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::NotebooksResponseData.new( type: null ) ``` - diff --git a/docs/v1/NotebooksResponseDataAttributes.md b/docs/v1/NotebooksResponseDataAttributes.md index 3c76f3280593..8fd0c50292e2 100644 --- a/docs/v1/NotebooksResponseDataAttributes.md +++ b/docs/v1/NotebooksResponseDataAttributes.md @@ -2,16 +2,16 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **author** | [**NotebookAuthor**](NotebookAuthor.md) | | [optional] | -| **cells** | [**Array<NotebookCellResponse>**](NotebookCellResponse.md) | List of cells to display in the notebook. | [optional] | -| **created** | **Time** | UTC time stamp for when the notebook was created. | [optional][readonly] | -| **metadata** | [**NotebookMetadata**](NotebookMetadata.md) | | [optional] | -| **modified** | **Time** | UTC time stamp for when the notebook was last modified. | [optional][readonly] | -| **name** | **String** | The name of the notebook. | | -| **status** | [**NotebookStatus**](NotebookStatus.md) | | [optional][default to 'published'] | -| **time** | [**NotebookGlobalTime**](NotebookGlobalTime.md) | | [optional] | +| Name | Type | Description | Notes | +| ------------ | ---------------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------ | +| **author** | [**NotebookAuthor**](NotebookAuthor.md) | | [optional] | +| **cells** | [**Array<NotebookCellResponse>**](NotebookCellResponse.md) | List of cells to display in the notebook. | [optional] | +| **created** | **Time** | UTC time stamp for when the notebook was created. | [optional][readonly] | +| **metadata** | [**NotebookMetadata**](NotebookMetadata.md) | | [optional] | +| **modified** | **Time** | UTC time stamp for when the notebook was last modified. | [optional][readonly] | +| **name** | **String** | The name of the notebook. | | +| **status** | [**NotebookStatus**](NotebookStatus.md) | | [optional][default to 'published'] | +| **time** | [**NotebookGlobalTime**](NotebookGlobalTime.md) | | [optional] | ## Example @@ -29,4 +29,3 @@ instance = DatadogAPIClient::V1::NotebooksResponseDataAttributes.new( time: null ) ``` - diff --git a/docs/v1/NotebooksResponseMeta.md b/docs/v1/NotebooksResponseMeta.md index a6b3e7f09748..b094a9f486dd 100644 --- a/docs/v1/NotebooksResponseMeta.md +++ b/docs/v1/NotebooksResponseMeta.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **page** | [**NotebooksResponsePage**](NotebooksResponsePage.md) | | [optional] | +| Name | Type | Description | Notes | +| -------- | ----------------------------------------------------- | ----------- | ---------- | +| **page** | [**NotebooksResponsePage**](NotebooksResponsePage.md) | | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::NotebooksResponseMeta.new( page: null ) ``` - diff --git a/docs/v1/NotebooksResponsePage.md b/docs/v1/NotebooksResponsePage.md index f408ca3e96c6..bbe3251c3d7b 100644 --- a/docs/v1/NotebooksResponsePage.md +++ b/docs/v1/NotebooksResponsePage.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **total_count** | **Integer** | The total number of notebooks that would be returned if the request was not filtered by `start` and `count` parameters. | [optional] | -| **total_filtered_count** | **Integer** | The total number of notebooks returned. | [optional] | +| Name | Type | Description | Notes | +| ------------------------ | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **total_count** | **Integer** | The total number of notebooks that would be returned if the request was not filtered by `start` and `count` parameters. | [optional] | +| **total_filtered_count** | **Integer** | The total number of notebooks returned. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::NotebooksResponsePage.new( total_filtered_count: null ) ``` - diff --git a/docs/v1/Organization.md b/docs/v1/Organization.md index 71c76241009a..d236b9d73c81 100644 --- a/docs/v1/Organization.md +++ b/docs/v1/Organization.md @@ -2,15 +2,15 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **billing** | [**OrganizationBilling**](OrganizationBilling.md) | | [optional] | -| **created** | **String** | Date of the organization creation. | [optional][readonly] | -| **description** | **String** | Description of the organization. | [optional] | -| **name** | **String** | The name of the new child-organization, limited to 32 characters. | [optional] | -| **public_id** | **String** | The `public_id` of the organization you are operating within. | [optional] | -| **settings** | [**OrganizationSettings**](OrganizationSettings.md) | | [optional] | -| **subscription** | [**OrganizationSubscription**](OrganizationSubscription.md) | | [optional] | +| Name | Type | Description | Notes | +| ---------------- | ----------------------------------------------------------- | ----------------------------------------------------------------------- | -------------------- | +| **billing** | [**OrganizationBilling**](OrganizationBilling.md) | | [optional] | +| **created** | **String** | Date of the organization creation. | [optional][readonly] | +| **description** | **String** | Description of the organization. | [optional] | +| **name** | **String** | The name of the new child-organization, limited to 32 characters. | [optional] | +| **public_id** | **String** | The `public_id` of the organization you are operating within. | [optional] | +| **settings** | [**OrganizationSettings**](OrganizationSettings.md) | | [optional] | +| **subscription** | [**OrganizationSubscription**](OrganizationSubscription.md) | | [optional] | ## Example @@ -27,4 +27,3 @@ instance = DatadogAPIClient::V1::Organization.new( subscription: null ) ``` - diff --git a/docs/v1/OrganizationBilling.md b/docs/v1/OrganizationBilling.md index 6553b20e7dd0..2e80738b6eac 100644 --- a/docs/v1/OrganizationBilling.md +++ b/docs/v1/OrganizationBilling.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| -------- | ---------- | ------------------------------------------------------------------ | ---------- | | **type** | **String** | The type of billing. Only `parent_billing` is supported. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::OrganizationBilling.new( type: null ) ``` - diff --git a/docs/v1/OrganizationCreateBody.md b/docs/v1/OrganizationCreateBody.md index 643d3489684c..df7273afe343 100644 --- a/docs/v1/OrganizationCreateBody.md +++ b/docs/v1/OrganizationCreateBody.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **billing** | [**OrganizationBilling**](OrganizationBilling.md) | | [optional] | -| **name** | **String** | The name of the new child-organization, limited to 32 characters. | | -| **subscription** | [**OrganizationSubscription**](OrganizationSubscription.md) | | [optional] | +| Name | Type | Description | Notes | +| ---------------- | ----------------------------------------------------------- | ----------------------------------------------------------------- | ---------- | +| **billing** | [**OrganizationBilling**](OrganizationBilling.md) | | [optional] | +| **name** | **String** | The name of the new child-organization, limited to 32 characters. | | +| **subscription** | [**OrganizationSubscription**](OrganizationSubscription.md) | | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::OrganizationCreateBody.new( subscription: null ) ``` - diff --git a/docs/v1/OrganizationCreateResponse.md b/docs/v1/OrganizationCreateResponse.md index f9e47bc357a3..4661a9a36922 100644 --- a/docs/v1/OrganizationCreateResponse.md +++ b/docs/v1/OrganizationCreateResponse.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **api_key** | [**ApiKey**](ApiKey.md) | | [optional] | -| **application_key** | [**ApplicationKey**](ApplicationKey.md) | | [optional] | -| **org** | [**Organization**](Organization.md) | | [optional] | -| **user** | [**User**](User.md) | | [optional] | +| Name | Type | Description | Notes | +| ------------------- | --------------------------------------- | ----------- | ---------- | +| **api_key** | [**ApiKey**](ApiKey.md) | | [optional] | +| **application_key** | [**ApplicationKey**](ApplicationKey.md) | | [optional] | +| **org** | [**Organization**](Organization.md) | | [optional] | +| **user** | [**User**](User.md) | | [optional] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V1::OrganizationCreateResponse.new( user: null ) ``` - diff --git a/docs/v1/OrganizationListResponse.md b/docs/v1/OrganizationListResponse.md index 7f07e6b7c56e..8c3206d03edb 100644 --- a/docs/v1/OrganizationListResponse.md +++ b/docs/v1/OrganizationListResponse.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| -------- | ------------------------------------------------ | ------------------------------ | ---------- | | **orgs** | [**Array<Organization>**](Organization.md) | Array of organization objects. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::OrganizationListResponse.new( orgs: null ) ``` - diff --git a/docs/v1/OrganizationResponse.md b/docs/v1/OrganizationResponse.md index 5de27505c359..1e031fa8f565 100644 --- a/docs/v1/OrganizationResponse.md +++ b/docs/v1/OrganizationResponse.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **org** | [**Organization**](Organization.md) | | [optional] | +| Name | Type | Description | Notes | +| ------- | ----------------------------------- | ----------- | ---------- | +| **org** | [**Organization**](Organization.md) | | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::OrganizationResponse.new( org: null ) ``` - diff --git a/docs/v1/OrganizationSettings.md b/docs/v1/OrganizationSettings.md index a28170e14180..b9db86a136ce 100644 --- a/docs/v1/OrganizationSettings.md +++ b/docs/v1/OrganizationSettings.md @@ -2,18 +2,18 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **private_widget_share** | **Boolean** | Whether or not the organization users can share widgets outside of Datadog. | [optional] | -| **saml** | [**OrganizationSettingsSaml**](OrganizationSettingsSaml.md) | | [optional] | -| **saml_autocreate_access_role** | [**AccessRole**](AccessRole.md) | | [optional][default to 'st'] | -| **saml_autocreate_users_domains** | [**OrganizationSettingsSamlAutocreateUsersDomains**](OrganizationSettingsSamlAutocreateUsersDomains.md) | | [optional] | -| **saml_can_be_enabled** | **Boolean** | Whether or not SAML can be enabled for this organization. | [optional] | -| **saml_idp_endpoint** | **String** | Identity provider endpoint for SAML authentication. | [optional] | -| **saml_idp_initiated_login** | [**OrganizationSettingsSamlIdpInitiatedLogin**](OrganizationSettingsSamlIdpInitiatedLogin.md) | | [optional] | -| **saml_idp_metadata_uploaded** | **Boolean** | Whether or not a SAML identity provider metadata file was provided to the Datadog organization. | [optional] | -| **saml_login_url** | **String** | URL for SAML logging. | [optional] | -| **saml_strict_mode** | [**OrganizationSettingsSamlStrictMode**](OrganizationSettingsSamlStrictMode.md) | | [optional] | +| Name | Type | Description | Notes | +| --------------------------------- | ------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------- | +| **private_widget_share** | **Boolean** | Whether or not the organization users can share widgets outside of Datadog. | [optional] | +| **saml** | [**OrganizationSettingsSaml**](OrganizationSettingsSaml.md) | | [optional] | +| **saml_autocreate_access_role** | [**AccessRole**](AccessRole.md) | | [optional][default to 'st'] | +| **saml_autocreate_users_domains** | [**OrganizationSettingsSamlAutocreateUsersDomains**](OrganizationSettingsSamlAutocreateUsersDomains.md) | | [optional] | +| **saml_can_be_enabled** | **Boolean** | Whether or not SAML can be enabled for this organization. | [optional] | +| **saml_idp_endpoint** | **String** | Identity provider endpoint for SAML authentication. | [optional] | +| **saml_idp_initiated_login** | [**OrganizationSettingsSamlIdpInitiatedLogin**](OrganizationSettingsSamlIdpInitiatedLogin.md) | | [optional] | +| **saml_idp_metadata_uploaded** | **Boolean** | Whether or not a SAML identity provider metadata file was provided to the Datadog organization. | [optional] | +| **saml_login_url** | **String** | URL for SAML logging. | [optional] | +| **saml_strict_mode** | [**OrganizationSettingsSamlStrictMode**](OrganizationSettingsSamlStrictMode.md) | | [optional] | ## Example @@ -33,4 +33,3 @@ instance = DatadogAPIClient::V1::OrganizationSettings.new( saml_strict_mode: null ) ``` - diff --git a/docs/v1/OrganizationSettingsSaml.md b/docs/v1/OrganizationSettingsSaml.md index 08dc94490944..ebc469f6ccbf 100644 --- a/docs/v1/OrganizationSettingsSaml.md +++ b/docs/v1/OrganizationSettingsSaml.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| ----------- | ----------- | ----------------------------------------------------- | ---------- | | **enabled** | **Boolean** | Whether or not SAML is enabled for this organization. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::OrganizationSettingsSaml.new( enabled: false ) ``` - diff --git a/docs/v1/OrganizationSettingsSamlAutocreateUsersDomains.md b/docs/v1/OrganizationSettingsSamlAutocreateUsersDomains.md index 2e3d8c8cdbee..afe4053682ac 100644 --- a/docs/v1/OrganizationSettingsSamlAutocreateUsersDomains.md +++ b/docs/v1/OrganizationSettingsSamlAutocreateUsersDomains.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **domains** | **Array<String>** | List of domains where the SAML automated user creation is enabled. | [optional] | -| **enabled** | **Boolean** | Whether or not the automated user creation based on SAML domain is enabled. | [optional] | +| Name | Type | Description | Notes | +| ----------- | ----------------------- | --------------------------------------------------------------------------- | ---------- | +| **domains** | **Array<String>** | List of domains where the SAML automated user creation is enabled. | [optional] | +| **enabled** | **Boolean** | Whether or not the automated user creation based on SAML domain is enabled. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::OrganizationSettingsSamlAutocreateUsersDomains. enabled: false ) ``` - diff --git a/docs/v1/OrganizationSettingsSamlIdpInitiatedLogin.md b/docs/v1/OrganizationSettingsSamlIdpInitiatedLogin.md index cf52b4f7f8b3..b2a4a1a940c9 100644 --- a/docs/v1/OrganizationSettingsSamlIdpInitiatedLogin.md +++ b/docs/v1/OrganizationSettingsSamlIdpInitiatedLogin.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| ----------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | | **enabled** | **Boolean** | Whether SAML IdP initiated login is enabled, learn more in the [SAML documentation](https://docs.datadoghq.com/account_management/saml/#idp-initiated-login). | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::OrganizationSettingsSamlIdpInitiatedLogin.new( enabled: false ) ``` - diff --git a/docs/v1/OrganizationSettingsSamlStrictMode.md b/docs/v1/OrganizationSettingsSamlStrictMode.md index 9e88b982acea..8b84535473e9 100644 --- a/docs/v1/OrganizationSettingsSamlStrictMode.md +++ b/docs/v1/OrganizationSettingsSamlStrictMode.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| ----------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | | **enabled** | **Boolean** | Whether or not the SAML strict mode is enabled. If true, all users must log in with SAML. Learn more on the [SAML Strict documentation](https://docs.datadoghq.com/account_management/saml/#saml-strict). | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::OrganizationSettingsSamlStrictMode.new( enabled: false ) ``` - diff --git a/docs/v1/OrganizationSubscription.md b/docs/v1/OrganizationSubscription.md index 324eab994633..eef4e774e1b0 100644 --- a/docs/v1/OrganizationSubscription.md +++ b/docs/v1/OrganizationSubscription.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| -------- | ---------- | ---------------------------------------------------------------------------------------------------- | ---------- | | **type** | **String** | The subscription type. Types available are `trial`, `free`, and `pro`. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::OrganizationSubscription.new( type: null ) ``` - diff --git a/docs/v1/OrganizationsAPI.md b/docs/v1/OrganizationsAPI.md index 5e122b97cf28..caa6e0927d8b 100644 --- a/docs/v1/OrganizationsAPI.md +++ b/docs/v1/OrganizationsAPI.md @@ -2,14 +2,13 @@ All URIs are relative to *https://api.datadoghq.com* -| Method | HTTP request | Description | -| ------ | ------------ | ----------- | -| [**create_child_org**](OrganizationsAPI.md#create_child_org) | **POST** /api/v1/org | Create a child organization | -| [**get_org**](OrganizationsAPI.md#get_org) | **GET** /api/v1/org/{public_id} | Get organization information | -| [**list_orgs**](OrganizationsAPI.md#list_orgs) | **GET** /api/v1/org | List your managed organizations | -| [**update_org**](OrganizationsAPI.md#update_org) | **PUT** /api/v1/org/{public_id} | Update your organization | -| [**upload_id_p_for_org**](OrganizationsAPI.md#upload_id_p_for_org) | **POST** /api/v1/org/{public_id}/idp_metadata | Upload IdP metadata | - +| Method | HTTP request | Description | +| ------------------------------------------------------------------ | --------------------------------------------- | ------------------------------- | +| [**create_child_org**](OrganizationsAPI.md#create_child_org) | **POST** /api/v1/org | Create a child organization | +| [**get_org**](OrganizationsAPI.md#get_org) | **GET** /api/v1/org/{public_id} | Get organization information | +| [**list_orgs**](OrganizationsAPI.md#list_orgs) | **GET** /api/v1/org | List your managed organizations | +| [**update_org**](OrganizationsAPI.md#update_org) | **PUT** /api/v1/org/{public_id} | Update your organization | +| [**upload_id_p_for_org**](OrganizationsAPI.md#upload_id_p_for_org) | **POST** /api/v1/org/{public_id}/idp_metadata | Upload IdP metadata | ## create_child_org @@ -62,9 +61,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**OrganizationCreateBody**](OrganizationCreateBody.md) | Organization object that needs to be created | | +| Name | Type | Description | Notes | +| -------- | ------------------------------------------------------- | -------------------------------------------- | ----- | +| **body** | [**OrganizationCreateBody**](OrganizationCreateBody.md) | Organization object that needs to be created | | ### Return type @@ -79,7 +78,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## get_org > get_org(public_id) @@ -122,9 +120,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **public_id** | **String** | The `public_id` of the organization you are operating within. | | +| Name | Type | Description | Notes | +| ------------- | ---------- | ----------------------------------------------------------------------- | ----- | +| **public_id** | **String** | The `public_id` of the organization you are operating within. | | ### Return type @@ -139,7 +137,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## list_orgs > list_orgs @@ -196,7 +193,6 @@ This endpoint does not need any parameter. - **Content-Type**: Not defined - **Accept**: application/json - ## update_org > update_org(public_id, body) @@ -209,7 +205,7 @@ Update your organization. require 'datadog_api_client' api_instance = DatadogAPIClient::V1::OrganizationsAPI.new public_id = 'abc123' # String | The `public_id` of the organization you are operating within. -body = DatadogAPIClient::V1::Organization.new # Organization | +body = DatadogAPIClient::V1::Organization.new # Organization | begin # Update your organization @@ -240,10 +236,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **public_id** | **String** | The `public_id` of the organization you are operating within. | | -| **body** | [**Organization**](Organization.md) | | | +| Name | Type | Description | Notes | +| ------------- | ----------------------------------- | ----------------------------------------------------------------------- | ----- | +| **public_id** | **String** | The `public_id` of the organization you are operating within. | | +| **body** | [**Organization**](Organization.md) | | | ### Return type @@ -258,7 +254,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## upload_id_p_for_org > upload_id_p_for_org(public_id, idp_file) @@ -266,9 +261,9 @@ end There are a couple of options for updating the Identity Provider (IdP) metadata from your SAML IdP. -* **Multipart Form-Data**: Post the IdP metadata file using a form post. +- **Multipart Form-Data**: Post the IdP metadata file using a form post. -* **XML Body:** Post the IdP metadata file as the body of the request. +- **XML Body:** Post the IdP metadata file as the body of the request. ### Examples @@ -307,10 +302,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **public_id** | **String** | The `public_id` of the organization you are operating with | | -| **idp_file** | **File** | The path to the XML metadata file you wish to upload. | | +| Name | Type | Description | Notes | +| ------------- | ---------- | -------------------------------------------------------------------- | ----- | +| **public_id** | **String** | The `public_id` of the organization you are operating with | | +| **idp_file** | **File** | The path to the XML metadata file you wish to upload. | | ### Return type @@ -324,4 +319,3 @@ end - **Content-Type**: multipart/form-data - **Accept**: application/json - diff --git a/docs/v1/PagerDutyIntegrationAPI.md b/docs/v1/PagerDutyIntegrationAPI.md index 8538b23c081b..1fffd70e040c 100644 --- a/docs/v1/PagerDutyIntegrationAPI.md +++ b/docs/v1/PagerDutyIntegrationAPI.md @@ -2,13 +2,12 @@ All URIs are relative to *https://api.datadoghq.com* -| Method | HTTP request | Description | -| ------ | ------------ | ----------- | -| [**create_pager_duty_integration_service**](PagerDutyIntegrationAPI.md#create_pager_duty_integration_service) | **POST** /api/v1/integration/pagerduty/configuration/services | Create a new service object | +| Method | HTTP request | Description | +| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | ------------------------------ | +| [**create_pager_duty_integration_service**](PagerDutyIntegrationAPI.md#create_pager_duty_integration_service) | **POST** /api/v1/integration/pagerduty/configuration/services | Create a new service object | | [**delete_pager_duty_integration_service**](PagerDutyIntegrationAPI.md#delete_pager_duty_integration_service) | **DELETE** /api/v1/integration/pagerduty/configuration/services/{service_name} | Delete a single service object | -| [**get_pager_duty_integration_service**](PagerDutyIntegrationAPI.md#get_pager_duty_integration_service) | **GET** /api/v1/integration/pagerduty/configuration/services/{service_name} | Get a single service object | -| [**update_pager_duty_integration_service**](PagerDutyIntegrationAPI.md#update_pager_duty_integration_service) | **PUT** /api/v1/integration/pagerduty/configuration/services/{service_name} | Update a single service object | - +| [**get_pager_duty_integration_service**](PagerDutyIntegrationAPI.md#get_pager_duty_integration_service) | **GET** /api/v1/integration/pagerduty/configuration/services/{service_name} | Get a single service object | +| [**update_pager_duty_integration_service**](PagerDutyIntegrationAPI.md#update_pager_duty_integration_service) | **PUT** /api/v1/integration/pagerduty/configuration/services/{service_name} | Update a single service object | ## create_pager_duty_integration_service @@ -52,9 +51,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**PagerDutyService**](PagerDutyService.md) | Create a new service object request body. | | +| Name | Type | Description | Notes | +| -------- | ------------------------------------------- | ----------------------------------------- | ----- | +| **body** | [**PagerDutyService**](PagerDutyService.md) | Create a new service object request body. | | ### Return type @@ -69,7 +68,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## delete_pager_duty_integration_service > delete_pager_duty_integration_service(service_name) @@ -111,9 +109,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **service_name** | **String** | The service name | | +| Name | Type | Description | Notes | +| ---------------- | ---------- | ---------------- | ----- | +| **service_name** | **String** | The service name | | ### Return type @@ -128,7 +126,6 @@ nil (empty response body) - **Content-Type**: Not defined - **Accept**: application/json - ## get_pager_duty_integration_service > get_pager_duty_integration_service(service_name) @@ -171,9 +168,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **service_name** | **String** | The service name. | | +| Name | Type | Description | Notes | +| ---------------- | ---------- | ----------------- | ----- | +| **service_name** | **String** | The service name. | | ### Return type @@ -188,7 +185,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## update_pager_duty_integration_service > update_pager_duty_integration_service(service_name, body) @@ -231,10 +227,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **service_name** | **String** | The service name | | -| **body** | [**PagerDutyServiceKey**](PagerDutyServiceKey.md) | Update an existing service object request body. | | +| Name | Type | Description | Notes | +| ---------------- | ------------------------------------------------- | ----------------------------------------------- | ----- | +| **service_name** | **String** | The service name | | +| **body** | [**PagerDutyServiceKey**](PagerDutyServiceKey.md) | Update an existing service object request body. | | ### Return type @@ -248,4 +244,3 @@ nil (empty response body) - **Content-Type**: application/json - **Accept**: application/json - diff --git a/docs/v1/PagerDutyService.md b/docs/v1/PagerDutyService.md index bc40571ba09e..c1896e7daced 100644 --- a/docs/v1/PagerDutyService.md +++ b/docs/v1/PagerDutyService.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **service_key** | **String** | Your service key in PagerDuty. | | -| **service_name** | **String** | Your service name associated with a service key in PagerDuty. | | +| Name | Type | Description | Notes | +| ---------------- | ---------- | ------------------------------------------------------------- | ----- | +| **service_key** | **String** | Your service key in PagerDuty. | | +| **service_name** | **String** | Your service name associated with a service key in PagerDuty. | | ## Example @@ -14,7 +14,6 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::PagerDutyService.new( service_key: , - service_name: + service_name: ) ``` - diff --git a/docs/v1/PagerDutyServiceKey.md b/docs/v1/PagerDutyServiceKey.md index daf503b2b96d..9b607f7162b4 100644 --- a/docs/v1/PagerDutyServiceKey.md +++ b/docs/v1/PagerDutyServiceKey.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **service_key** | **String** | Your service key in PagerDuty. | | +| Name | Type | Description | Notes | +| --------------- | ---------- | ------------------------------ | ----- | +| **service_key** | **String** | Your service key in PagerDuty. | | ## Example @@ -12,7 +12,6 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::PagerDutyServiceKey.new( - service_key: + service_key: ) ``` - diff --git a/docs/v1/PagerDutyServiceName.md b/docs/v1/PagerDutyServiceName.md index 3d95fe409787..2ad7b3c55f3f 100644 --- a/docs/v1/PagerDutyServiceName.md +++ b/docs/v1/PagerDutyServiceName.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **service_name** | **String** | Your service name associated service key in PagerDuty. | | +| Name | Type | Description | Notes | +| ---------------- | ---------- | ------------------------------------------------------ | ----- | +| **service_name** | **String** | Your service name associated service key in PagerDuty. | | ## Example @@ -12,7 +12,6 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::PagerDutyServiceName.new( - service_name: + service_name: ) ``` - diff --git a/docs/v1/Pagination.md b/docs/v1/Pagination.md index 354edc909445..547b9a6f4cb3 100644 --- a/docs/v1/Pagination.md +++ b/docs/v1/Pagination.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **total_count** | **Integer** | Total count. | [optional] | +| Name | Type | Description | Notes | +| ------------------------ | ----------- | ---------------------------------------------- | ---------- | +| **total_count** | **Integer** | Total count. | [optional] | | **total_filtered_count** | **Integer** | Total count of elements matched by the filter. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::Pagination.new( total_filtered_count: null ) ``` - diff --git a/docs/v1/ProcessQueryDefinition.md b/docs/v1/ProcessQueryDefinition.md index 86bf8eab5bce..85fd30fc99b7 100644 --- a/docs/v1/ProcessQueryDefinition.md +++ b/docs/v1/ProcessQueryDefinition.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **filter_by** | **Array<String>** | List of processes. | [optional] | -| **limit** | **Integer** | Max number of items in the filter list. | [optional] | -| **metric** | **String** | Your chosen metric. | | -| **search_by** | **String** | Your chosen search term. | [optional] | +| Name | Type | Description | Notes | +| ------------- | ----------------------- | --------------------------------------- | ---------- | +| **filter_by** | **Array<String>** | List of processes. | [optional] | +| **limit** | **Integer** | Max number of items in the filter list. | [optional] | +| **metric** | **String** | Your chosen metric. | | +| **search_by** | **String** | Your chosen search term. | [optional] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V1::ProcessQueryDefinition.new( search_by: null ) ``` - diff --git a/docs/v1/QuerySortOrder.md b/docs/v1/QuerySortOrder.md index 18e36fb09841..7235d7933167 100644 --- a/docs/v1/QuerySortOrder.md +++ b/docs/v1/QuerySortOrder.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::QuerySortOrder.new() ``` - diff --git a/docs/v1/QueryValueWidgetDefinition.md b/docs/v1/QueryValueWidgetDefinition.md index 4328f1d443fb..f747abd4d9e9 100644 --- a/docs/v1/QueryValueWidgetDefinition.md +++ b/docs/v1/QueryValueWidgetDefinition.md @@ -2,19 +2,19 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **autoscale** | **Boolean** | Whether to use auto-scaling or not. | [optional] | -| **custom_links** | [**Array<WidgetCustomLink>**](WidgetCustomLink.md) | List of custom links. | [optional] | -| **custom_unit** | **String** | Display a unit of your choice on the widget. | [optional] | -| **precision** | **Integer** | Number of decimals to show. If not defined, the widget uses the raw value. | [optional] | -| **requests** | [**Array<QueryValueWidgetRequest>**](QueryValueWidgetRequest.md) | Widget definition. | | -| **text_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | -| **time** | [**WidgetTime**](WidgetTime.md) | | [optional] | -| **title** | **String** | Title of your widget. | [optional] | -| **title_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | -| **title_size** | **String** | Size of the title. | [optional] | -| **type** | [**QueryValueWidgetDefinitionType**](QueryValueWidgetDefinitionType.md) | | [default to 'query_value'] | +| Name | Type | Description | Notes | +| ---------------- | ----------------------------------------------------------------------- | -------------------------------------------------------------------------- | ---------------------------------- | +| **autoscale** | **Boolean** | Whether to use auto-scaling or not. | [optional] | +| **custom_links** | [**Array<WidgetCustomLink>**](WidgetCustomLink.md) | List of custom links. | [optional] | +| **custom_unit** | **String** | Display a unit of your choice on the widget. | [optional] | +| **precision** | **Integer** | Number of decimals to show. If not defined, the widget uses the raw value. | [optional] | +| **requests** | [**Array<QueryValueWidgetRequest>**](QueryValueWidgetRequest.md) | Widget definition. | | +| **text_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | +| **time** | [**WidgetTime**](WidgetTime.md) | | [optional] | +| **title** | **String** | Title of your widget. | [optional] | +| **title_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | +| **title_size** | **String** | Size of the title. | [optional] | +| **type** | [**QueryValueWidgetDefinitionType**](QueryValueWidgetDefinitionType.md) | | [default to 'query_value'] | ## Example @@ -35,4 +35,3 @@ instance = DatadogAPIClient::V1::QueryValueWidgetDefinition.new( type: null ) ``` - diff --git a/docs/v1/QueryValueWidgetDefinitionType.md b/docs/v1/QueryValueWidgetDefinitionType.md index bd09e19cce27..ab89b8370bff 100644 --- a/docs/v1/QueryValueWidgetDefinitionType.md +++ b/docs/v1/QueryValueWidgetDefinitionType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::QueryValueWidgetDefinitionType.new() ``` - diff --git a/docs/v1/QueryValueWidgetRequest.md b/docs/v1/QueryValueWidgetRequest.md index 6305e3a69de7..f42bafe375df 100644 --- a/docs/v1/QueryValueWidgetRequest.md +++ b/docs/v1/QueryValueWidgetRequest.md @@ -2,23 +2,23 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **aggregator** | [**WidgetAggregator**](WidgetAggregator.md) | | [optional] | -| **apm_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **audit_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **conditional_formats** | [**Array<WidgetConditionalFormat>**](WidgetConditionalFormat.md) | List of conditional formats. | [optional] | -| **event_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **formulas** | [**Array<WidgetFormula>**](WidgetFormula.md) | List of formulas that operate on queries. **This feature is currently in beta.** | [optional] | -| **log_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **network_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **process_query** | [**ProcessQueryDefinition**](ProcessQueryDefinition.md) | | [optional] | -| **profile_metrics_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **q** | **String** | TODO. | [optional] | -| **queries** | [**Array<FormulaAndFunctionQueryDefinition>**](FormulaAndFunctionQueryDefinition.md) | List of queries that can be returned directly or used in formulas. **This feature is currently in beta.** | [optional] | -| **response_format** | [**FormulaAndFunctionResponseFormat**](FormulaAndFunctionResponseFormat.md) | | [optional] | -| **rum_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **security_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| Name | Type | Description | Notes | +| ------------------------- | ------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------- | ---------- | +| **aggregator** | [**WidgetAggregator**](WidgetAggregator.md) | | [optional] | +| **apm_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **audit_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **conditional_formats** | [**Array<WidgetConditionalFormat>**](WidgetConditionalFormat.md) | List of conditional formats. | [optional] | +| **event_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **formulas** | [**Array<WidgetFormula>**](WidgetFormula.md) | List of formulas that operate on queries. **This feature is currently in beta.** | [optional] | +| **log_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **network_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **process_query** | [**ProcessQueryDefinition**](ProcessQueryDefinition.md) | | [optional] | +| **profile_metrics_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **q** | **String** | TODO. | [optional] | +| **queries** | [**Array<FormulaAndFunctionQueryDefinition>**](FormulaAndFunctionQueryDefinition.md) | List of queries that can be returned directly or used in formulas. **This feature is currently in beta.** | [optional] | +| **response_format** | [**FormulaAndFunctionResponseFormat**](FormulaAndFunctionResponseFormat.md) | | [optional] | +| **rum_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **security_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | ## Example @@ -43,4 +43,3 @@ instance = DatadogAPIClient::V1::QueryValueWidgetRequest.new( security_query: null ) ``` - diff --git a/docs/v1/README.md b/docs/v1/README.md index d73929470d42..d8e4323d58da 100644 --- a/docs/v1/README.md +++ b/docs/v1/README.md @@ -29,863 +29,859 @@ end All URIs are relative to *https://api.datadoghq.com* -Class | Method | HTTP request | Description ------------- | ------------- | ------------- | ------------- -*DatadogAPIClient::V1::AWSIntegrationAPI* | [**create_aws_account**](AWSIntegrationAPI.md#create_aws_account) | **POST** /api/v1/integration/aws | Create an AWS integration -*DatadogAPIClient::V1::AWSIntegrationAPI* | [**create_aws_tag_filter**](AWSIntegrationAPI.md#create_aws_tag_filter) | **POST** /api/v1/integration/aws/filtering | Set an AWS tag filter -*DatadogAPIClient::V1::AWSIntegrationAPI* | [**create_new_aws_external_id**](AWSIntegrationAPI.md#create_new_aws_external_id) | **PUT** /api/v1/integration/aws/generate_new_external_id | Generate a new external ID -*DatadogAPIClient::V1::AWSIntegrationAPI* | [**delete_aws_account**](AWSIntegrationAPI.md#delete_aws_account) | **DELETE** /api/v1/integration/aws | Delete an AWS integration -*DatadogAPIClient::V1::AWSIntegrationAPI* | [**delete_aws_tag_filter**](AWSIntegrationAPI.md#delete_aws_tag_filter) | **DELETE** /api/v1/integration/aws/filtering | Delete a tag filtering entry -*DatadogAPIClient::V1::AWSIntegrationAPI* | [**list_available_aws_namespaces**](AWSIntegrationAPI.md#list_available_aws_namespaces) | **GET** /api/v1/integration/aws/available_namespace_rules | List namespace rules -*DatadogAPIClient::V1::AWSIntegrationAPI* | [**list_aws_accounts**](AWSIntegrationAPI.md#list_aws_accounts) | **GET** /api/v1/integration/aws | List all AWS integrations -*DatadogAPIClient::V1::AWSIntegrationAPI* | [**list_aws_tag_filters**](AWSIntegrationAPI.md#list_aws_tag_filters) | **GET** /api/v1/integration/aws/filtering | Get all AWS tag filters -*DatadogAPIClient::V1::AWSIntegrationAPI* | [**update_aws_account**](AWSIntegrationAPI.md#update_aws_account) | **PUT** /api/v1/integration/aws | Update an AWS integration -*DatadogAPIClient::V1::AWSLogsIntegrationAPI* | [**check_aws_logs_lambda_async**](AWSLogsIntegrationAPI.md#check_aws_logs_lambda_async) | **POST** /api/v1/integration/aws/logs/check_async | Check that an AWS Lambda Function exists -*DatadogAPIClient::V1::AWSLogsIntegrationAPI* | [**check_aws_logs_services_async**](AWSLogsIntegrationAPI.md#check_aws_logs_services_async) | **POST** /api/v1/integration/aws/logs/services_async | Check permissions for log services -*DatadogAPIClient::V1::AWSLogsIntegrationAPI* | [**create_aws_lambda_arn**](AWSLogsIntegrationAPI.md#create_aws_lambda_arn) | **POST** /api/v1/integration/aws/logs | Add AWS Log Lambda ARN -*DatadogAPIClient::V1::AWSLogsIntegrationAPI* | [**delete_aws_lambda_arn**](AWSLogsIntegrationAPI.md#delete_aws_lambda_arn) | **DELETE** /api/v1/integration/aws/logs | Delete an AWS Logs integration -*DatadogAPIClient::V1::AWSLogsIntegrationAPI* | [**enable_aws_log_services**](AWSLogsIntegrationAPI.md#enable_aws_log_services) | **POST** /api/v1/integration/aws/logs/services | Enable an AWS Logs integration -*DatadogAPIClient::V1::AWSLogsIntegrationAPI* | [**list_aws_logs_integrations**](AWSLogsIntegrationAPI.md#list_aws_logs_integrations) | **GET** /api/v1/integration/aws/logs | List all AWS Logs integrations -*DatadogAPIClient::V1::AWSLogsIntegrationAPI* | [**list_aws_logs_services**](AWSLogsIntegrationAPI.md#list_aws_logs_services) | **GET** /api/v1/integration/aws/logs/services | Get list of AWS log ready services -*DatadogAPIClient::V1::AuthenticationAPI* | [**validate**](AuthenticationAPI.md#validate) | **GET** /api/v1/validate | Validate API key -*DatadogAPIClient::V1::AzureIntegrationAPI* | [**create_azure_integration**](AzureIntegrationAPI.md#create_azure_integration) | **POST** /api/v1/integration/azure | Create an Azure integration -*DatadogAPIClient::V1::AzureIntegrationAPI* | [**delete_azure_integration**](AzureIntegrationAPI.md#delete_azure_integration) | **DELETE** /api/v1/integration/azure | Delete an Azure integration -*DatadogAPIClient::V1::AzureIntegrationAPI* | [**list_azure_integration**](AzureIntegrationAPI.md#list_azure_integration) | **GET** /api/v1/integration/azure | List all Azure integrations -*DatadogAPIClient::V1::AzureIntegrationAPI* | [**update_azure_host_filters**](AzureIntegrationAPI.md#update_azure_host_filters) | **POST** /api/v1/integration/azure/host_filters | Update Azure integration host filters -*DatadogAPIClient::V1::AzureIntegrationAPI* | [**update_azure_integration**](AzureIntegrationAPI.md#update_azure_integration) | **PUT** /api/v1/integration/azure | Update an Azure integration -*DatadogAPIClient::V1::DashboardListsAPI* | [**create_dashboard_list**](DashboardListsAPI.md#create_dashboard_list) | **POST** /api/v1/dashboard/lists/manual | Create a dashboard list -*DatadogAPIClient::V1::DashboardListsAPI* | [**delete_dashboard_list**](DashboardListsAPI.md#delete_dashboard_list) | **DELETE** /api/v1/dashboard/lists/manual/{list_id} | Delete a dashboard list -*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 -*DatadogAPIClient::V1::DowntimesAPI* | [**list_downtimes**](DowntimesAPI.md#list_downtimes) | **GET** /api/v1/downtime | Get all downtimes -*DatadogAPIClient::V1::DowntimesAPI* | [**list_monitor_downtimes**](DowntimesAPI.md#list_monitor_downtimes) | **GET** /api/v1/monitor/{monitor_id}/downtimes | Get all downtimes for a monitor -*DatadogAPIClient::V1::DowntimesAPI* | [**update_downtime**](DowntimesAPI.md#update_downtime) | **PUT** /api/v1/downtime/{downtime_id} | Update a downtime -*DatadogAPIClient::V1::EventsAPI* | [**create_event**](EventsAPI.md#create_event) | **POST** /api/v1/events | Post an event -*DatadogAPIClient::V1::EventsAPI* | [**get_event**](EventsAPI.md#get_event) | **GET** /api/v1/events/{event_id} | Get an event -*DatadogAPIClient::V1::EventsAPI* | [**list_events**](EventsAPI.md#list_events) | **GET** /api/v1/events | Query the event stream -*DatadogAPIClient::V1::GCPIntegrationAPI* | [**create_gcp_integration**](GCPIntegrationAPI.md#create_gcp_integration) | **POST** /api/v1/integration/gcp | Create a GCP integration -*DatadogAPIClient::V1::GCPIntegrationAPI* | [**delete_gcp_integration**](GCPIntegrationAPI.md#delete_gcp_integration) | **DELETE** /api/v1/integration/gcp | Delete a GCP integration -*DatadogAPIClient::V1::GCPIntegrationAPI* | [**list_gcp_integration**](GCPIntegrationAPI.md#list_gcp_integration) | **GET** /api/v1/integration/gcp | List all GCP integrations -*DatadogAPIClient::V1::GCPIntegrationAPI* | [**update_gcp_integration**](GCPIntegrationAPI.md#update_gcp_integration) | **PUT** /api/v1/integration/gcp | Update a GCP integration -*DatadogAPIClient::V1::HostsAPI* | [**get_host_totals**](HostsAPI.md#get_host_totals) | **GET** /api/v1/hosts/totals | Get the total number of active hosts -*DatadogAPIClient::V1::HostsAPI* | [**list_hosts**](HostsAPI.md#list_hosts) | **GET** /api/v1/hosts | Get all hosts for your organization -*DatadogAPIClient::V1::HostsAPI* | [**mute_host**](HostsAPI.md#mute_host) | **POST** /api/v1/host/{host_name}/mute | Mute a host -*DatadogAPIClient::V1::HostsAPI* | [**unmute_host**](HostsAPI.md#unmute_host) | **POST** /api/v1/host/{host_name}/unmute | Unmute a host -*DatadogAPIClient::V1::IPRangesAPI* | [**get_ip_ranges**](IPRangesAPI.md#get_ip_ranges) | **GET** / | List IP Ranges -*DatadogAPIClient::V1::KeyManagementAPI* | [**create_api_key**](KeyManagementAPI.md#create_api_key) | **POST** /api/v1/api_key | Create an API key -*DatadogAPIClient::V1::KeyManagementAPI* | [**create_application_key**](KeyManagementAPI.md#create_application_key) | **POST** /api/v1/application_key | Create an application key -*DatadogAPIClient::V1::KeyManagementAPI* | [**delete_api_key**](KeyManagementAPI.md#delete_api_key) | **DELETE** /api/v1/api_key/{key} | Delete an API key -*DatadogAPIClient::V1::KeyManagementAPI* | [**delete_application_key**](KeyManagementAPI.md#delete_application_key) | **DELETE** /api/v1/application_key/{key} | Delete an application key -*DatadogAPIClient::V1::KeyManagementAPI* | [**get_api_key**](KeyManagementAPI.md#get_api_key) | **GET** /api/v1/api_key/{key} | Get API key -*DatadogAPIClient::V1::KeyManagementAPI* | [**get_application_key**](KeyManagementAPI.md#get_application_key) | **GET** /api/v1/application_key/{key} | Get an application key -*DatadogAPIClient::V1::KeyManagementAPI* | [**list_api_keys**](KeyManagementAPI.md#list_api_keys) | **GET** /api/v1/api_key | Get all API keys -*DatadogAPIClient::V1::KeyManagementAPI* | [**list_application_keys**](KeyManagementAPI.md#list_application_keys) | **GET** /api/v1/application_key | Get all application keys -*DatadogAPIClient::V1::KeyManagementAPI* | [**update_api_key**](KeyManagementAPI.md#update_api_key) | **PUT** /api/v1/api_key/{key} | Edit an API key -*DatadogAPIClient::V1::KeyManagementAPI* | [**update_application_key**](KeyManagementAPI.md#update_application_key) | **PUT** /api/v1/application_key/{key} | Edit an application key -*DatadogAPIClient::V1::LogsAPI* | [**list_logs**](LogsAPI.md#list_logs) | **POST** /api/v1/logs-queries/list | Search logs -*DatadogAPIClient::V1::LogsAPI* | [**submit_log**](LogsAPI.md#submit_log) | **POST** /v1/input | Send logs -*DatadogAPIClient::V1::LogsIndexesAPI* | [**create_logs_index**](LogsIndexesAPI.md#create_logs_index) | **POST** /api/v1/logs/config/indexes | Create an index -*DatadogAPIClient::V1::LogsIndexesAPI* | [**get_logs_index**](LogsIndexesAPI.md#get_logs_index) | **GET** /api/v1/logs/config/indexes/{name} | Get an index -*DatadogAPIClient::V1::LogsIndexesAPI* | [**get_logs_index_order**](LogsIndexesAPI.md#get_logs_index_order) | **GET** /api/v1/logs/config/index-order | Get indexes order -*DatadogAPIClient::V1::LogsIndexesAPI* | [**list_log_indexes**](LogsIndexesAPI.md#list_log_indexes) | **GET** /api/v1/logs/config/indexes | Get all indexes -*DatadogAPIClient::V1::LogsIndexesAPI* | [**update_logs_index**](LogsIndexesAPI.md#update_logs_index) | **PUT** /api/v1/logs/config/indexes/{name} | Update an index -*DatadogAPIClient::V1::LogsIndexesAPI* | [**update_logs_index_order**](LogsIndexesAPI.md#update_logs_index_order) | **PUT** /api/v1/logs/config/index-order | Update indexes order -*DatadogAPIClient::V1::LogsPipelinesAPI* | [**create_logs_pipeline**](LogsPipelinesAPI.md#create_logs_pipeline) | **POST** /api/v1/logs/config/pipelines | Create a pipeline -*DatadogAPIClient::V1::LogsPipelinesAPI* | [**delete_logs_pipeline**](LogsPipelinesAPI.md#delete_logs_pipeline) | **DELETE** /api/v1/logs/config/pipelines/{pipeline_id} | Delete a pipeline -*DatadogAPIClient::V1::LogsPipelinesAPI* | [**get_logs_pipeline**](LogsPipelinesAPI.md#get_logs_pipeline) | **GET** /api/v1/logs/config/pipelines/{pipeline_id} | Get a pipeline -*DatadogAPIClient::V1::LogsPipelinesAPI* | [**get_logs_pipeline_order**](LogsPipelinesAPI.md#get_logs_pipeline_order) | **GET** /api/v1/logs/config/pipeline-order | Get pipeline order -*DatadogAPIClient::V1::LogsPipelinesAPI* | [**list_logs_pipelines**](LogsPipelinesAPI.md#list_logs_pipelines) | **GET** /api/v1/logs/config/pipelines | Get all pipelines -*DatadogAPIClient::V1::LogsPipelinesAPI* | [**update_logs_pipeline**](LogsPipelinesAPI.md#update_logs_pipeline) | **PUT** /api/v1/logs/config/pipelines/{pipeline_id} | Update a pipeline -*DatadogAPIClient::V1::LogsPipelinesAPI* | [**update_logs_pipeline_order**](LogsPipelinesAPI.md#update_logs_pipeline_order) | **PUT** /api/v1/logs/config/pipeline-order | Update pipeline order -*DatadogAPIClient::V1::MetricsAPI* | [**get_metric_metadata**](MetricsAPI.md#get_metric_metadata) | **GET** /api/v1/metrics/{metric_name} | Get metric metadata -*DatadogAPIClient::V1::MetricsAPI* | [**list_active_metrics**](MetricsAPI.md#list_active_metrics) | **GET** /api/v1/metrics | Get active metrics list -*DatadogAPIClient::V1::MetricsAPI* | [**list_metrics**](MetricsAPI.md#list_metrics) | **GET** /api/v1/search | Search metrics -*DatadogAPIClient::V1::MetricsAPI* | [**query_metrics**](MetricsAPI.md#query_metrics) | **GET** /api/v1/query | Query timeseries points -*DatadogAPIClient::V1::MetricsAPI* | [**submit_metrics**](MetricsAPI.md#submit_metrics) | **POST** /api/v1/series | Submit metrics -*DatadogAPIClient::V1::MetricsAPI* | [**update_metric_metadata**](MetricsAPI.md#update_metric_metadata) | **PUT** /api/v1/metrics/{metric_name} | Edit metric metadata -*DatadogAPIClient::V1::MonitorsAPI* | [**check_can_delete_monitor**](MonitorsAPI.md#check_can_delete_monitor) | **GET** /api/v1/monitor/can_delete | Check if a monitor can be deleted -*DatadogAPIClient::V1::MonitorsAPI* | [**create_monitor**](MonitorsAPI.md#create_monitor) | **POST** /api/v1/monitor | Create a monitor -*DatadogAPIClient::V1::MonitorsAPI* | [**delete_monitor**](MonitorsAPI.md#delete_monitor) | **DELETE** /api/v1/monitor/{monitor_id} | Delete a monitor -*DatadogAPIClient::V1::MonitorsAPI* | [**get_monitor**](MonitorsAPI.md#get_monitor) | **GET** /api/v1/monitor/{monitor_id} | Get a monitor's details -*DatadogAPIClient::V1::MonitorsAPI* | [**list_monitors**](MonitorsAPI.md#list_monitors) | **GET** /api/v1/monitor | Get all monitor details -*DatadogAPIClient::V1::MonitorsAPI* | [**search_monitor_groups**](MonitorsAPI.md#search_monitor_groups) | **GET** /api/v1/monitor/groups/search | Monitors group search -*DatadogAPIClient::V1::MonitorsAPI* | [**search_monitors**](MonitorsAPI.md#search_monitors) | **GET** /api/v1/monitor/search | Monitors search -*DatadogAPIClient::V1::MonitorsAPI* | [**update_monitor**](MonitorsAPI.md#update_monitor) | **PUT** /api/v1/monitor/{monitor_id} | Edit a monitor -*DatadogAPIClient::V1::MonitorsAPI* | [**validate_monitor**](MonitorsAPI.md#validate_monitor) | **POST** /api/v1/monitor/validate | Validate a monitor -*DatadogAPIClient::V1::NotebooksAPI* | [**create_notebook**](NotebooksAPI.md#create_notebook) | **POST** /api/v1/notebooks | Create a notebook -*DatadogAPIClient::V1::NotebooksAPI* | [**delete_notebook**](NotebooksAPI.md#delete_notebook) | **DELETE** /api/v1/notebooks/{notebook_id} | Delete a notebook -*DatadogAPIClient::V1::NotebooksAPI* | [**get_notebook**](NotebooksAPI.md#get_notebook) | **GET** /api/v1/notebooks/{notebook_id} | Get a notebook -*DatadogAPIClient::V1::NotebooksAPI* | [**list_notebooks**](NotebooksAPI.md#list_notebooks) | **GET** /api/v1/notebooks | Get all notebooks -*DatadogAPIClient::V1::NotebooksAPI* | [**update_notebook**](NotebooksAPI.md#update_notebook) | **PUT** /api/v1/notebooks/{notebook_id} | Update a notebook -*DatadogAPIClient::V1::OrganizationsAPI* | [**create_child_org**](OrganizationsAPI.md#create_child_org) | **POST** /api/v1/org | Create a child organization -*DatadogAPIClient::V1::OrganizationsAPI* | [**get_org**](OrganizationsAPI.md#get_org) | **GET** /api/v1/org/{public_id} | Get organization information -*DatadogAPIClient::V1::OrganizationsAPI* | [**list_orgs**](OrganizationsAPI.md#list_orgs) | **GET** /api/v1/org | List your managed organizations -*DatadogAPIClient::V1::OrganizationsAPI* | [**update_org**](OrganizationsAPI.md#update_org) | **PUT** /api/v1/org/{public_id} | Update your organization -*DatadogAPIClient::V1::OrganizationsAPI* | [**upload_id_p_for_org**](OrganizationsAPI.md#upload_id_p_for_org) | **POST** /api/v1/org/{public_id}/idp_metadata | Upload IdP metadata -*DatadogAPIClient::V1::PagerDutyIntegrationAPI* | [**create_pager_duty_integration_service**](PagerDutyIntegrationAPI.md#create_pager_duty_integration_service) | **POST** /api/v1/integration/pagerduty/configuration/services | Create a new service object -*DatadogAPIClient::V1::PagerDutyIntegrationAPI* | [**delete_pager_duty_integration_service**](PagerDutyIntegrationAPI.md#delete_pager_duty_integration_service) | **DELETE** /api/v1/integration/pagerduty/configuration/services/{service_name} | Delete a single service object -*DatadogAPIClient::V1::PagerDutyIntegrationAPI* | [**get_pager_duty_integration_service**](PagerDutyIntegrationAPI.md#get_pager_duty_integration_service) | **GET** /api/v1/integration/pagerduty/configuration/services/{service_name} | Get a single service object -*DatadogAPIClient::V1::PagerDutyIntegrationAPI* | [**update_pager_duty_integration_service**](PagerDutyIntegrationAPI.md#update_pager_duty_integration_service) | **PUT** /api/v1/integration/pagerduty/configuration/services/{service_name} | Update a single service object -*DatadogAPIClient::V1::ServiceChecksAPI* | [**submit_service_check**](ServiceChecksAPI.md#submit_service_check) | **POST** /api/v1/check_run | Submit a Service Check -*DatadogAPIClient::V1::ServiceLevelObjectiveCorrectionsAPI* | [**create_slo_correction**](ServiceLevelObjectiveCorrectionsAPI.md#create_slo_correction) | **POST** /api/v1/slo/correction | Create an SLO correction -*DatadogAPIClient::V1::ServiceLevelObjectiveCorrectionsAPI* | [**delete_slo_correction**](ServiceLevelObjectiveCorrectionsAPI.md#delete_slo_correction) | **DELETE** /api/v1/slo/correction/{slo_correction_id} | Delete an SLO correction -*DatadogAPIClient::V1::ServiceLevelObjectiveCorrectionsAPI* | [**get_slo_correction**](ServiceLevelObjectiveCorrectionsAPI.md#get_slo_correction) | **GET** /api/v1/slo/correction/{slo_correction_id} | Get an SLO correction for an SLO -*DatadogAPIClient::V1::ServiceLevelObjectiveCorrectionsAPI* | [**list_slo_correction**](ServiceLevelObjectiveCorrectionsAPI.md#list_slo_correction) | **GET** /api/v1/slo/correction | Get all SLO corrections -*DatadogAPIClient::V1::ServiceLevelObjectiveCorrectionsAPI* | [**update_slo_correction**](ServiceLevelObjectiveCorrectionsAPI.md#update_slo_correction) | **PATCH** /api/v1/slo/correction/{slo_correction_id} | Update an SLO correction -*DatadogAPIClient::V1::ServiceLevelObjectivesAPI* | [**check_can_delete_slo**](ServiceLevelObjectivesAPI.md#check_can_delete_slo) | **GET** /api/v1/slo/can_delete | Check if SLOs can be safely deleted -*DatadogAPIClient::V1::ServiceLevelObjectivesAPI* | [**create_slo**](ServiceLevelObjectivesAPI.md#create_slo) | **POST** /api/v1/slo | Create an SLO object -*DatadogAPIClient::V1::ServiceLevelObjectivesAPI* | [**delete_slo**](ServiceLevelObjectivesAPI.md#delete_slo) | **DELETE** /api/v1/slo/{slo_id} | Delete an SLO -*DatadogAPIClient::V1::ServiceLevelObjectivesAPI* | [**delete_slo_timeframe_in_bulk**](ServiceLevelObjectivesAPI.md#delete_slo_timeframe_in_bulk) | **POST** /api/v1/slo/bulk_delete | Bulk Delete SLO Timeframes -*DatadogAPIClient::V1::ServiceLevelObjectivesAPI* | [**get_slo**](ServiceLevelObjectivesAPI.md#get_slo) | **GET** /api/v1/slo/{slo_id} | Get an SLO's details -*DatadogAPIClient::V1::ServiceLevelObjectivesAPI* | [**get_slo_history**](ServiceLevelObjectivesAPI.md#get_slo_history) | **GET** /api/v1/slo/{slo_id}/history | Get an SLO's history -*DatadogAPIClient::V1::ServiceLevelObjectivesAPI* | [**list_slos**](ServiceLevelObjectivesAPI.md#list_slos) | **GET** /api/v1/slo | Get all SLOs -*DatadogAPIClient::V1::ServiceLevelObjectivesAPI* | [**update_slo**](ServiceLevelObjectivesAPI.md#update_slo) | **PUT** /api/v1/slo/{slo_id} | Update an SLO -*DatadogAPIClient::V1::SlackIntegrationAPI* | [**create_slack_integration_channel**](SlackIntegrationAPI.md#create_slack_integration_channel) | **POST** /api/v1/integration/slack/configuration/accounts/{account_name}/channels | Create a Slack integration channel -*DatadogAPIClient::V1::SlackIntegrationAPI* | [**get_slack_integration_channel**](SlackIntegrationAPI.md#get_slack_integration_channel) | **GET** /api/v1/integration/slack/configuration/accounts/{account_name}/channels/{channel_name} | Get a Slack integration channel -*DatadogAPIClient::V1::SlackIntegrationAPI* | [**get_slack_integration_channels**](SlackIntegrationAPI.md#get_slack_integration_channels) | **GET** /api/v1/integration/slack/configuration/accounts/{account_name}/channels | Get all channels in a Slack integration -*DatadogAPIClient::V1::SlackIntegrationAPI* | [**remove_slack_integration_channel**](SlackIntegrationAPI.md#remove_slack_integration_channel) | **DELETE** /api/v1/integration/slack/configuration/accounts/{account_name}/channels/{channel_name} | Remove a Slack integration channel -*DatadogAPIClient::V1::SlackIntegrationAPI* | [**update_slack_integration_channel**](SlackIntegrationAPI.md#update_slack_integration_channel) | **PATCH** /api/v1/integration/slack/configuration/accounts/{account_name}/channels/{channel_name} | Update a Slack integration channel -*DatadogAPIClient::V1::SnapshotsAPI* | [**get_graph_snapshot**](SnapshotsAPI.md#get_graph_snapshot) | **GET** /api/v1/graph/snapshot | Take graph snapshots -*DatadogAPIClient::V1::SyntheticsAPI* | [**create_global_variable**](SyntheticsAPI.md#create_global_variable) | **POST** /api/v1/synthetics/variables | Create a global variable -*DatadogAPIClient::V1::SyntheticsAPI* | [**create_private_location**](SyntheticsAPI.md#create_private_location) | **POST** /api/v1/synthetics/private-locations | Create a private location -*DatadogAPIClient::V1::SyntheticsAPI* | [**create_synthetics_api_test**](SyntheticsAPI.md#create_synthetics_api_test) | **POST** /api/v1/synthetics/tests/api | Create an API test -*DatadogAPIClient::V1::SyntheticsAPI* | [**create_synthetics_browser_test**](SyntheticsAPI.md#create_synthetics_browser_test) | **POST** /api/v1/synthetics/tests/browser | Create a browser test -*DatadogAPIClient::V1::SyntheticsAPI* | [**delete_global_variable**](SyntheticsAPI.md#delete_global_variable) | **DELETE** /api/v1/synthetics/variables/{variable_id} | Delete a global variable -*DatadogAPIClient::V1::SyntheticsAPI* | [**delete_private_location**](SyntheticsAPI.md#delete_private_location) | **DELETE** /api/v1/synthetics/private-locations/{location_id} | Delete a private location -*DatadogAPIClient::V1::SyntheticsAPI* | [**delete_tests**](SyntheticsAPI.md#delete_tests) | **POST** /api/v1/synthetics/tests/delete | Delete tests -*DatadogAPIClient::V1::SyntheticsAPI* | [**edit_global_variable**](SyntheticsAPI.md#edit_global_variable) | **PUT** /api/v1/synthetics/variables/{variable_id} | Edit a global variable -*DatadogAPIClient::V1::SyntheticsAPI* | [**get_api_test**](SyntheticsAPI.md#get_api_test) | **GET** /api/v1/synthetics/tests/api/{public_id} | Get an API test -*DatadogAPIClient::V1::SyntheticsAPI* | [**get_api_test_latest_results**](SyntheticsAPI.md#get_api_test_latest_results) | **GET** /api/v1/synthetics/tests/{public_id}/results | Get an API test's latest results summaries -*DatadogAPIClient::V1::SyntheticsAPI* | [**get_api_test_result**](SyntheticsAPI.md#get_api_test_result) | **GET** /api/v1/synthetics/tests/{public_id}/results/{result_id} | Get an API test result -*DatadogAPIClient::V1::SyntheticsAPI* | [**get_browser_test**](SyntheticsAPI.md#get_browser_test) | **GET** /api/v1/synthetics/tests/browser/{public_id} | Get a browser test -*DatadogAPIClient::V1::SyntheticsAPI* | [**get_browser_test_latest_results**](SyntheticsAPI.md#get_browser_test_latest_results) | **GET** /api/v1/synthetics/tests/browser/{public_id}/results | Get a browser test's latest results summaries -*DatadogAPIClient::V1::SyntheticsAPI* | [**get_browser_test_result**](SyntheticsAPI.md#get_browser_test_result) | **GET** /api/v1/synthetics/tests/browser/{public_id}/results/{result_id} | Get a browser test result -*DatadogAPIClient::V1::SyntheticsAPI* | [**get_global_variable**](SyntheticsAPI.md#get_global_variable) | **GET** /api/v1/synthetics/variables/{variable_id} | Get a global variable -*DatadogAPIClient::V1::SyntheticsAPI* | [**get_private_location**](SyntheticsAPI.md#get_private_location) | **GET** /api/v1/synthetics/private-locations/{location_id} | Get a private location -*DatadogAPIClient::V1::SyntheticsAPI* | [**get_synthetics_ci_batch**](SyntheticsAPI.md#get_synthetics_ci_batch) | **GET** /api/v1/synthetics/ci/batch/{batch_id} | Get details of batch -*DatadogAPIClient::V1::SyntheticsAPI* | [**get_test**](SyntheticsAPI.md#get_test) | **GET** /api/v1/synthetics/tests/{public_id} | Get a test configuration -*DatadogAPIClient::V1::SyntheticsAPI* | [**list_global_variables**](SyntheticsAPI.md#list_global_variables) | **GET** /api/v1/synthetics/variables | Get all global variables -*DatadogAPIClient::V1::SyntheticsAPI* | [**list_locations**](SyntheticsAPI.md#list_locations) | **GET** /api/v1/synthetics/locations | Get all locations (public and private) -*DatadogAPIClient::V1::SyntheticsAPI* | [**list_tests**](SyntheticsAPI.md#list_tests) | **GET** /api/v1/synthetics/tests | Get the list of all tests -*DatadogAPIClient::V1::SyntheticsAPI* | [**trigger_ci_tests**](SyntheticsAPI.md#trigger_ci_tests) | **POST** /api/v1/synthetics/tests/trigger/ci | Trigger tests from CI/CD pipelines -*DatadogAPIClient::V1::SyntheticsAPI* | [**update_api_test**](SyntheticsAPI.md#update_api_test) | **PUT** /api/v1/synthetics/tests/api/{public_id} | Edit an API test -*DatadogAPIClient::V1::SyntheticsAPI* | [**update_browser_test**](SyntheticsAPI.md#update_browser_test) | **PUT** /api/v1/synthetics/tests/browser/{public_id} | Edit a browser test -*DatadogAPIClient::V1::SyntheticsAPI* | [**update_private_location**](SyntheticsAPI.md#update_private_location) | **PUT** /api/v1/synthetics/private-locations/{location_id} | Edit a private location -*DatadogAPIClient::V1::SyntheticsAPI* | [**update_test_pause_status**](SyntheticsAPI.md#update_test_pause_status) | **PUT** /api/v1/synthetics/tests/{public_id}/status | Pause or start a test -*DatadogAPIClient::V1::TagsAPI* | [**create_host_tags**](TagsAPI.md#create_host_tags) | **POST** /api/v1/tags/hosts/{host_name} | Add tags to a host -*DatadogAPIClient::V1::TagsAPI* | [**delete_host_tags**](TagsAPI.md#delete_host_tags) | **DELETE** /api/v1/tags/hosts/{host_name} | Remove host tags -*DatadogAPIClient::V1::TagsAPI* | [**get_host_tags**](TagsAPI.md#get_host_tags) | **GET** /api/v1/tags/hosts/{host_name} | Get host tags -*DatadogAPIClient::V1::TagsAPI* | [**list_host_tags**](TagsAPI.md#list_host_tags) | **GET** /api/v1/tags/hosts | Get Tags -*DatadogAPIClient::V1::TagsAPI* | [**update_host_tags**](TagsAPI.md#update_host_tags) | **PUT** /api/v1/tags/hosts/{host_name} | Update host tags -*DatadogAPIClient::V1::UsageMeteringAPI* | [**get_daily_custom_reports**](UsageMeteringAPI.md#get_daily_custom_reports) | **GET** /api/v1/daily_custom_reports | Get the list of available daily custom reports -*DatadogAPIClient::V1::UsageMeteringAPI* | [**get_incident_management**](UsageMeteringAPI.md#get_incident_management) | **GET** /api/v1/usage/incident-management | Get hourly usage for incident management -*DatadogAPIClient::V1::UsageMeteringAPI* | [**get_ingested_spans**](UsageMeteringAPI.md#get_ingested_spans) | **GET** /api/v1/usage/ingested-spans | Get hourly usage for ingested spans -*DatadogAPIClient::V1::UsageMeteringAPI* | [**get_monthly_custom_reports**](UsageMeteringAPI.md#get_monthly_custom_reports) | **GET** /api/v1/monthly_custom_reports | Get the list of available monthly custom reports -*DatadogAPIClient::V1::UsageMeteringAPI* | [**get_specified_daily_custom_reports**](UsageMeteringAPI.md#get_specified_daily_custom_reports) | **GET** /api/v1/daily_custom_reports/{report_id} | Get specified daily custom reports -*DatadogAPIClient::V1::UsageMeteringAPI* | [**get_specified_monthly_custom_reports**](UsageMeteringAPI.md#get_specified_monthly_custom_reports) | **GET** /api/v1/monthly_custom_reports/{report_id} | Get specified monthly custom reports -*DatadogAPIClient::V1::UsageMeteringAPI* | [**get_usage_analyzed_logs**](UsageMeteringAPI.md#get_usage_analyzed_logs) | **GET** /api/v1/usage/analyzed_logs | Get hourly usage for analyzed logs -*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 -*DatadogAPIClient::V1::UsageMeteringAPI* | [**get_usage_logs**](UsageMeteringAPI.md#get_usage_logs) | **GET** /api/v1/usage/logs | Get hourly usage for Logs -*DatadogAPIClient::V1::UsageMeteringAPI* | [**get_usage_logs_by_index**](UsageMeteringAPI.md#get_usage_logs_by_index) | **GET** /api/v1/usage/logs_by_index | Get hourly usage for Logs by Index -*DatadogAPIClient::V1::UsageMeteringAPI* | [**get_usage_logs_by_retention**](UsageMeteringAPI.md#get_usage_logs_by_retention) | **GET** /api/v1/usage/logs-by-retention | Get hourly logs usage by retention -*DatadogAPIClient::V1::UsageMeteringAPI* | [**get_usage_network_flows**](UsageMeteringAPI.md#get_usage_network_flows) | **GET** /api/v1/usage/network_flows | Get hourly usage for Network Flows -*DatadogAPIClient::V1::UsageMeteringAPI* | [**get_usage_network_hosts**](UsageMeteringAPI.md#get_usage_network_hosts) | **GET** /api/v1/usage/network_hosts | Get hourly usage for Network Hosts -*DatadogAPIClient::V1::UsageMeteringAPI* | [**get_usage_profiling**](UsageMeteringAPI.md#get_usage_profiling) | **GET** /api/v1/usage/profiling | Get hourly usage for profiled hosts -*DatadogAPIClient::V1::UsageMeteringAPI* | [**get_usage_rum_sessions**](UsageMeteringAPI.md#get_usage_rum_sessions) | **GET** /api/v1/usage/rum_sessions | Get hourly usage for RUM Sessions -*DatadogAPIClient::V1::UsageMeteringAPI* | [**get_usage_sds**](UsageMeteringAPI.md#get_usage_sds) | **GET** /api/v1/usage/sds | Get hourly usage for Sensitive Data Scanner -*DatadogAPIClient::V1::UsageMeteringAPI* | [**get_usage_snmp**](UsageMeteringAPI.md#get_usage_snmp) | **GET** /api/v1/usage/snmp | Get hourly usage for SNMP devices -*DatadogAPIClient::V1::UsageMeteringAPI* | [**get_usage_summary**](UsageMeteringAPI.md#get_usage_summary) | **GET** /api/v1/usage/summary | Get usage across your multi-org account -*DatadogAPIClient::V1::UsageMeteringAPI* | [**get_usage_synthetics**](UsageMeteringAPI.md#get_usage_synthetics) | **GET** /api/v1/usage/synthetics | Get hourly usage for Synthetics Checks -*DatadogAPIClient::V1::UsageMeteringAPI* | [**get_usage_synthetics_api**](UsageMeteringAPI.md#get_usage_synthetics_api) | **GET** /api/v1/usage/synthetics_api | Get hourly usage for Synthetics API Checks -*DatadogAPIClient::V1::UsageMeteringAPI* | [**get_usage_synthetics_browser**](UsageMeteringAPI.md#get_usage_synthetics_browser) | **GET** /api/v1/usage/synthetics_browser | Get hourly usage for Synthetics Browser Checks -*DatadogAPIClient::V1::UsageMeteringAPI* | [**get_usage_timeseries**](UsageMeteringAPI.md#get_usage_timeseries) | **GET** /api/v1/usage/timeseries | Get hourly usage for custom metrics -*DatadogAPIClient::V1::UsageMeteringAPI* | [**get_usage_top_avg_metrics**](UsageMeteringAPI.md#get_usage_top_avg_metrics) | **GET** /api/v1/usage/top_avg_metrics | Get all custom metrics by hourly average -*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 - +| Class | Method | HTTP request | Description | +| ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------- | ------------------------------------------------ | +| _DatadogAPIClient::V1::AWSIntegrationAPI_ | [**create_aws_account**](AWSIntegrationAPI.md#create_aws_account) | **POST** /api/v1/integration/aws | Create an AWS integration | +| _DatadogAPIClient::V1::AWSIntegrationAPI_ | [**create_aws_tag_filter**](AWSIntegrationAPI.md#create_aws_tag_filter) | **POST** /api/v1/integration/aws/filtering | Set an AWS tag filter | +| _DatadogAPIClient::V1::AWSIntegrationAPI_ | [**create_new_aws_external_id**](AWSIntegrationAPI.md#create_new_aws_external_id) | **PUT** /api/v1/integration/aws/generate_new_external_id | Generate a new external ID | +| _DatadogAPIClient::V1::AWSIntegrationAPI_ | [**delete_aws_account**](AWSIntegrationAPI.md#delete_aws_account) | **DELETE** /api/v1/integration/aws | Delete an AWS integration | +| _DatadogAPIClient::V1::AWSIntegrationAPI_ | [**delete_aws_tag_filter**](AWSIntegrationAPI.md#delete_aws_tag_filter) | **DELETE** /api/v1/integration/aws/filtering | Delete a tag filtering entry | +| _DatadogAPIClient::V1::AWSIntegrationAPI_ | [**list_available_aws_namespaces**](AWSIntegrationAPI.md#list_available_aws_namespaces) | **GET** /api/v1/integration/aws/available_namespace_rules | List namespace rules | +| _DatadogAPIClient::V1::AWSIntegrationAPI_ | [**list_aws_accounts**](AWSIntegrationAPI.md#list_aws_accounts) | **GET** /api/v1/integration/aws | List all AWS integrations | +| _DatadogAPIClient::V1::AWSIntegrationAPI_ | [**list_aws_tag_filters**](AWSIntegrationAPI.md#list_aws_tag_filters) | **GET** /api/v1/integration/aws/filtering | Get all AWS tag filters | +| _DatadogAPIClient::V1::AWSIntegrationAPI_ | [**update_aws_account**](AWSIntegrationAPI.md#update_aws_account) | **PUT** /api/v1/integration/aws | Update an AWS integration | +| _DatadogAPIClient::V1::AWSLogsIntegrationAPI_ | [**check_aws_logs_lambda_async**](AWSLogsIntegrationAPI.md#check_aws_logs_lambda_async) | **POST** /api/v1/integration/aws/logs/check_async | Check that an AWS Lambda Function exists | +| _DatadogAPIClient::V1::AWSLogsIntegrationAPI_ | [**check_aws_logs_services_async**](AWSLogsIntegrationAPI.md#check_aws_logs_services_async) | **POST** /api/v1/integration/aws/logs/services_async | Check permissions for log services | +| _DatadogAPIClient::V1::AWSLogsIntegrationAPI_ | [**create_aws_lambda_arn**](AWSLogsIntegrationAPI.md#create_aws_lambda_arn) | **POST** /api/v1/integration/aws/logs | Add AWS Log Lambda ARN | +| _DatadogAPIClient::V1::AWSLogsIntegrationAPI_ | [**delete_aws_lambda_arn**](AWSLogsIntegrationAPI.md#delete_aws_lambda_arn) | **DELETE** /api/v1/integration/aws/logs | Delete an AWS Logs integration | +| _DatadogAPIClient::V1::AWSLogsIntegrationAPI_ | [**enable_aws_log_services**](AWSLogsIntegrationAPI.md#enable_aws_log_services) | **POST** /api/v1/integration/aws/logs/services | Enable an AWS Logs integration | +| _DatadogAPIClient::V1::AWSLogsIntegrationAPI_ | [**list_aws_logs_integrations**](AWSLogsIntegrationAPI.md#list_aws_logs_integrations) | **GET** /api/v1/integration/aws/logs | List all AWS Logs integrations | +| _DatadogAPIClient::V1::AWSLogsIntegrationAPI_ | [**list_aws_logs_services**](AWSLogsIntegrationAPI.md#list_aws_logs_services) | **GET** /api/v1/integration/aws/logs/services | Get list of AWS log ready services | +| _DatadogAPIClient::V1::AuthenticationAPI_ | [**validate**](AuthenticationAPI.md#validate) | **GET** /api/v1/validate | Validate API key | +| _DatadogAPIClient::V1::AzureIntegrationAPI_ | [**create_azure_integration**](AzureIntegrationAPI.md#create_azure_integration) | **POST** /api/v1/integration/azure | Create an Azure integration | +| _DatadogAPIClient::V1::AzureIntegrationAPI_ | [**delete_azure_integration**](AzureIntegrationAPI.md#delete_azure_integration) | **DELETE** /api/v1/integration/azure | Delete an Azure integration | +| _DatadogAPIClient::V1::AzureIntegrationAPI_ | [**list_azure_integration**](AzureIntegrationAPI.md#list_azure_integration) | **GET** /api/v1/integration/azure | List all Azure integrations | +| _DatadogAPIClient::V1::AzureIntegrationAPI_ | [**update_azure_host_filters**](AzureIntegrationAPI.md#update_azure_host_filters) | **POST** /api/v1/integration/azure/host_filters | Update Azure integration host filters | +| _DatadogAPIClient::V1::AzureIntegrationAPI_ | [**update_azure_integration**](AzureIntegrationAPI.md#update_azure_integration) | **PUT** /api/v1/integration/azure | Update an Azure integration | +| _DatadogAPIClient::V1::DashboardListsAPI_ | [**create_dashboard_list**](DashboardListsAPI.md#create_dashboard_list) | **POST** /api/v1/dashboard/lists/manual | Create a dashboard list | +| _DatadogAPIClient::V1::DashboardListsAPI_ | [**delete_dashboard_list**](DashboardListsAPI.md#delete_dashboard_list) | **DELETE** /api/v1/dashboard/lists/manual/{list_id} | Delete a dashboard list | +| _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 | +| _DatadogAPIClient::V1::DowntimesAPI_ | [**list_downtimes**](DowntimesAPI.md#list_downtimes) | **GET** /api/v1/downtime | Get all downtimes | +| _DatadogAPIClient::V1::DowntimesAPI_ | [**list_monitor_downtimes**](DowntimesAPI.md#list_monitor_downtimes) | **GET** /api/v1/monitor/{monitor_id}/downtimes | Get all downtimes for a monitor | +| _DatadogAPIClient::V1::DowntimesAPI_ | [**update_downtime**](DowntimesAPI.md#update_downtime) | **PUT** /api/v1/downtime/{downtime_id} | Update a downtime | +| _DatadogAPIClient::V1::EventsAPI_ | [**create_event**](EventsAPI.md#create_event) | **POST** /api/v1/events | Post an event | +| _DatadogAPIClient::V1::EventsAPI_ | [**get_event**](EventsAPI.md#get_event) | **GET** /api/v1/events/{event_id} | Get an event | +| _DatadogAPIClient::V1::EventsAPI_ | [**list_events**](EventsAPI.md#list_events) | **GET** /api/v1/events | Query the event stream | +| _DatadogAPIClient::V1::GCPIntegrationAPI_ | [**create_gcp_integration**](GCPIntegrationAPI.md#create_gcp_integration) | **POST** /api/v1/integration/gcp | Create a GCP integration | +| _DatadogAPIClient::V1::GCPIntegrationAPI_ | [**delete_gcp_integration**](GCPIntegrationAPI.md#delete_gcp_integration) | **DELETE** /api/v1/integration/gcp | Delete a GCP integration | +| _DatadogAPIClient::V1::GCPIntegrationAPI_ | [**list_gcp_integration**](GCPIntegrationAPI.md#list_gcp_integration) | **GET** /api/v1/integration/gcp | List all GCP integrations | +| _DatadogAPIClient::V1::GCPIntegrationAPI_ | [**update_gcp_integration**](GCPIntegrationAPI.md#update_gcp_integration) | **PUT** /api/v1/integration/gcp | Update a GCP integration | +| _DatadogAPIClient::V1::HostsAPI_ | [**get_host_totals**](HostsAPI.md#get_host_totals) | **GET** /api/v1/hosts/totals | Get the total number of active hosts | +| _DatadogAPIClient::V1::HostsAPI_ | [**list_hosts**](HostsAPI.md#list_hosts) | **GET** /api/v1/hosts | Get all hosts for your organization | +| _DatadogAPIClient::V1::HostsAPI_ | [**mute_host**](HostsAPI.md#mute_host) | **POST** /api/v1/host/{host_name}/mute | Mute a host | +| _DatadogAPIClient::V1::HostsAPI_ | [**unmute_host**](HostsAPI.md#unmute_host) | **POST** /api/v1/host/{host_name}/unmute | Unmute a host | +| _DatadogAPIClient::V1::IPRangesAPI_ | [**get_ip_ranges**](IPRangesAPI.md#get_ip_ranges) | **GET** / | List IP Ranges | +| _DatadogAPIClient::V1::KeyManagementAPI_ | [**create_api_key**](KeyManagementAPI.md#create_api_key) | **POST** /api/v1/api_key | Create an API key | +| _DatadogAPIClient::V1::KeyManagementAPI_ | [**create_application_key**](KeyManagementAPI.md#create_application_key) | **POST** /api/v1/application_key | Create an application key | +| _DatadogAPIClient::V1::KeyManagementAPI_ | [**delete_api_key**](KeyManagementAPI.md#delete_api_key) | **DELETE** /api/v1/api_key/{key} | Delete an API key | +| _DatadogAPIClient::V1::KeyManagementAPI_ | [**delete_application_key**](KeyManagementAPI.md#delete_application_key) | **DELETE** /api/v1/application_key/{key} | Delete an application key | +| _DatadogAPIClient::V1::KeyManagementAPI_ | [**get_api_key**](KeyManagementAPI.md#get_api_key) | **GET** /api/v1/api_key/{key} | Get API key | +| _DatadogAPIClient::V1::KeyManagementAPI_ | [**get_application_key**](KeyManagementAPI.md#get_application_key) | **GET** /api/v1/application_key/{key} | Get an application key | +| _DatadogAPIClient::V1::KeyManagementAPI_ | [**list_api_keys**](KeyManagementAPI.md#list_api_keys) | **GET** /api/v1/api_key | Get all API keys | +| _DatadogAPIClient::V1::KeyManagementAPI_ | [**list_application_keys**](KeyManagementAPI.md#list_application_keys) | **GET** /api/v1/application_key | Get all application keys | +| _DatadogAPIClient::V1::KeyManagementAPI_ | [**update_api_key**](KeyManagementAPI.md#update_api_key) | **PUT** /api/v1/api_key/{key} | Edit an API key | +| _DatadogAPIClient::V1::KeyManagementAPI_ | [**update_application_key**](KeyManagementAPI.md#update_application_key) | **PUT** /api/v1/application_key/{key} | Edit an application key | +| _DatadogAPIClient::V1::LogsAPI_ | [**list_logs**](LogsAPI.md#list_logs) | **POST** /api/v1/logs-queries/list | Search logs | +| _DatadogAPIClient::V1::LogsAPI_ | [**submit_log**](LogsAPI.md#submit_log) | **POST** /v1/input | Send logs | +| _DatadogAPIClient::V1::LogsIndexesAPI_ | [**create_logs_index**](LogsIndexesAPI.md#create_logs_index) | **POST** /api/v1/logs/config/indexes | Create an index | +| _DatadogAPIClient::V1::LogsIndexesAPI_ | [**get_logs_index**](LogsIndexesAPI.md#get_logs_index) | **GET** /api/v1/logs/config/indexes/{name} | Get an index | +| _DatadogAPIClient::V1::LogsIndexesAPI_ | [**get_logs_index_order**](LogsIndexesAPI.md#get_logs_index_order) | **GET** /api/v1/logs/config/index-order | Get indexes order | +| _DatadogAPIClient::V1::LogsIndexesAPI_ | [**list_log_indexes**](LogsIndexesAPI.md#list_log_indexes) | **GET** /api/v1/logs/config/indexes | Get all indexes | +| _DatadogAPIClient::V1::LogsIndexesAPI_ | [**update_logs_index**](LogsIndexesAPI.md#update_logs_index) | **PUT** /api/v1/logs/config/indexes/{name} | Update an index | +| _DatadogAPIClient::V1::LogsIndexesAPI_ | [**update_logs_index_order**](LogsIndexesAPI.md#update_logs_index_order) | **PUT** /api/v1/logs/config/index-order | Update indexes order | +| _DatadogAPIClient::V1::LogsPipelinesAPI_ | [**create_logs_pipeline**](LogsPipelinesAPI.md#create_logs_pipeline) | **POST** /api/v1/logs/config/pipelines | Create a pipeline | +| _DatadogAPIClient::V1::LogsPipelinesAPI_ | [**delete_logs_pipeline**](LogsPipelinesAPI.md#delete_logs_pipeline) | **DELETE** /api/v1/logs/config/pipelines/{pipeline_id} | Delete a pipeline | +| _DatadogAPIClient::V1::LogsPipelinesAPI_ | [**get_logs_pipeline**](LogsPipelinesAPI.md#get_logs_pipeline) | **GET** /api/v1/logs/config/pipelines/{pipeline_id} | Get a pipeline | +| _DatadogAPIClient::V1::LogsPipelinesAPI_ | [**get_logs_pipeline_order**](LogsPipelinesAPI.md#get_logs_pipeline_order) | **GET** /api/v1/logs/config/pipeline-order | Get pipeline order | +| _DatadogAPIClient::V1::LogsPipelinesAPI_ | [**list_logs_pipelines**](LogsPipelinesAPI.md#list_logs_pipelines) | **GET** /api/v1/logs/config/pipelines | Get all pipelines | +| _DatadogAPIClient::V1::LogsPipelinesAPI_ | [**update_logs_pipeline**](LogsPipelinesAPI.md#update_logs_pipeline) | **PUT** /api/v1/logs/config/pipelines/{pipeline_id} | Update a pipeline | +| _DatadogAPIClient::V1::LogsPipelinesAPI_ | [**update_logs_pipeline_order**](LogsPipelinesAPI.md#update_logs_pipeline_order) | **PUT** /api/v1/logs/config/pipeline-order | Update pipeline order | +| _DatadogAPIClient::V1::MetricsAPI_ | [**get_metric_metadata**](MetricsAPI.md#get_metric_metadata) | **GET** /api/v1/metrics/{metric_name} | Get metric metadata | +| _DatadogAPIClient::V1::MetricsAPI_ | [**list_active_metrics**](MetricsAPI.md#list_active_metrics) | **GET** /api/v1/metrics | Get active metrics list | +| _DatadogAPIClient::V1::MetricsAPI_ | [**list_metrics**](MetricsAPI.md#list_metrics) | **GET** /api/v1/search | Search metrics | +| _DatadogAPIClient::V1::MetricsAPI_ | [**query_metrics**](MetricsAPI.md#query_metrics) | **GET** /api/v1/query | Query timeseries points | +| _DatadogAPIClient::V1::MetricsAPI_ | [**submit_metrics**](MetricsAPI.md#submit_metrics) | **POST** /api/v1/series | Submit metrics | +| _DatadogAPIClient::V1::MetricsAPI_ | [**update_metric_metadata**](MetricsAPI.md#update_metric_metadata) | **PUT** /api/v1/metrics/{metric_name} | Edit metric metadata | +| _DatadogAPIClient::V1::MonitorsAPI_ | [**check_can_delete_monitor**](MonitorsAPI.md#check_can_delete_monitor) | **GET** /api/v1/monitor/can_delete | Check if a monitor can be deleted | +| _DatadogAPIClient::V1::MonitorsAPI_ | [**create_monitor**](MonitorsAPI.md#create_monitor) | **POST** /api/v1/monitor | Create a monitor | +| _DatadogAPIClient::V1::MonitorsAPI_ | [**delete_monitor**](MonitorsAPI.md#delete_monitor) | **DELETE** /api/v1/monitor/{monitor_id} | Delete a monitor | +| _DatadogAPIClient::V1::MonitorsAPI_ | [**get_monitor**](MonitorsAPI.md#get_monitor) | **GET** /api/v1/monitor/{monitor_id} | Get a monitor's details | +| _DatadogAPIClient::V1::MonitorsAPI_ | [**list_monitors**](MonitorsAPI.md#list_monitors) | **GET** /api/v1/monitor | Get all monitor details | +| _DatadogAPIClient::V1::MonitorsAPI_ | [**search_monitor_groups**](MonitorsAPI.md#search_monitor_groups) | **GET** /api/v1/monitor/groups/search | Monitors group search | +| _DatadogAPIClient::V1::MonitorsAPI_ | [**search_monitors**](MonitorsAPI.md#search_monitors) | **GET** /api/v1/monitor/search | Monitors search | +| _DatadogAPIClient::V1::MonitorsAPI_ | [**update_monitor**](MonitorsAPI.md#update_monitor) | **PUT** /api/v1/monitor/{monitor_id} | Edit a monitor | +| _DatadogAPIClient::V1::MonitorsAPI_ | [**validate_monitor**](MonitorsAPI.md#validate_monitor) | **POST** /api/v1/monitor/validate | Validate a monitor | +| _DatadogAPIClient::V1::NotebooksAPI_ | [**create_notebook**](NotebooksAPI.md#create_notebook) | **POST** /api/v1/notebooks | Create a notebook | +| _DatadogAPIClient::V1::NotebooksAPI_ | [**delete_notebook**](NotebooksAPI.md#delete_notebook) | **DELETE** /api/v1/notebooks/{notebook_id} | Delete a notebook | +| _DatadogAPIClient::V1::NotebooksAPI_ | [**get_notebook**](NotebooksAPI.md#get_notebook) | **GET** /api/v1/notebooks/{notebook_id} | Get a notebook | +| _DatadogAPIClient::V1::NotebooksAPI_ | [**list_notebooks**](NotebooksAPI.md#list_notebooks) | **GET** /api/v1/notebooks | Get all notebooks | +| _DatadogAPIClient::V1::NotebooksAPI_ | [**update_notebook**](NotebooksAPI.md#update_notebook) | **PUT** /api/v1/notebooks/{notebook_id} | Update a notebook | +| _DatadogAPIClient::V1::OrganizationsAPI_ | [**create_child_org**](OrganizationsAPI.md#create_child_org) | **POST** /api/v1/org | Create a child organization | +| _DatadogAPIClient::V1::OrganizationsAPI_ | [**get_org**](OrganizationsAPI.md#get_org) | **GET** /api/v1/org/{public_id} | Get organization information | +| _DatadogAPIClient::V1::OrganizationsAPI_ | [**list_orgs**](OrganizationsAPI.md#list_orgs) | **GET** /api/v1/org | List your managed organizations | +| _DatadogAPIClient::V1::OrganizationsAPI_ | [**update_org**](OrganizationsAPI.md#update_org) | **PUT** /api/v1/org/{public_id} | Update your organization | +| _DatadogAPIClient::V1::OrganizationsAPI_ | [**upload_id_p_for_org**](OrganizationsAPI.md#upload_id_p_for_org) | **POST** /api/v1/org/{public_id}/idp_metadata | Upload IdP metadata | +| _DatadogAPIClient::V1::PagerDutyIntegrationAPI_ | [**create_pager_duty_integration_service**](PagerDutyIntegrationAPI.md#create_pager_duty_integration_service) | **POST** /api/v1/integration/pagerduty/configuration/services | Create a new service object | +| _DatadogAPIClient::V1::PagerDutyIntegrationAPI_ | [**delete_pager_duty_integration_service**](PagerDutyIntegrationAPI.md#delete_pager_duty_integration_service) | **DELETE** /api/v1/integration/pagerduty/configuration/services/{service_name} | Delete a single service object | +| _DatadogAPIClient::V1::PagerDutyIntegrationAPI_ | [**get_pager_duty_integration_service**](PagerDutyIntegrationAPI.md#get_pager_duty_integration_service) | **GET** /api/v1/integration/pagerduty/configuration/services/{service_name} | Get a single service object | +| _DatadogAPIClient::V1::PagerDutyIntegrationAPI_ | [**update_pager_duty_integration_service**](PagerDutyIntegrationAPI.md#update_pager_duty_integration_service) | **PUT** /api/v1/integration/pagerduty/configuration/services/{service_name} | Update a single service object | +| _DatadogAPIClient::V1::ServiceChecksAPI_ | [**submit_service_check**](ServiceChecksAPI.md#submit_service_check) | **POST** /api/v1/check_run | Submit a Service Check | +| _DatadogAPIClient::V1::ServiceLevelObjectiveCorrectionsAPI_ | [**create_slo_correction**](ServiceLevelObjectiveCorrectionsAPI.md#create_slo_correction) | **POST** /api/v1/slo/correction | Create an SLO correction | +| _DatadogAPIClient::V1::ServiceLevelObjectiveCorrectionsAPI_ | [**delete_slo_correction**](ServiceLevelObjectiveCorrectionsAPI.md#delete_slo_correction) | **DELETE** /api/v1/slo/correction/{slo_correction_id} | Delete an SLO correction | +| _DatadogAPIClient::V1::ServiceLevelObjectiveCorrectionsAPI_ | [**get_slo_correction**](ServiceLevelObjectiveCorrectionsAPI.md#get_slo_correction) | **GET** /api/v1/slo/correction/{slo_correction_id} | Get an SLO correction for an SLO | +| _DatadogAPIClient::V1::ServiceLevelObjectiveCorrectionsAPI_ | [**list_slo_correction**](ServiceLevelObjectiveCorrectionsAPI.md#list_slo_correction) | **GET** /api/v1/slo/correction | Get all SLO corrections | +| _DatadogAPIClient::V1::ServiceLevelObjectiveCorrectionsAPI_ | [**update_slo_correction**](ServiceLevelObjectiveCorrectionsAPI.md#update_slo_correction) | **PATCH** /api/v1/slo/correction/{slo_correction_id} | Update an SLO correction | +| _DatadogAPIClient::V1::ServiceLevelObjectivesAPI_ | [**check_can_delete_slo**](ServiceLevelObjectivesAPI.md#check_can_delete_slo) | **GET** /api/v1/slo/can_delete | Check if SLOs can be safely deleted | +| _DatadogAPIClient::V1::ServiceLevelObjectivesAPI_ | [**create_slo**](ServiceLevelObjectivesAPI.md#create_slo) | **POST** /api/v1/slo | Create an SLO object | +| _DatadogAPIClient::V1::ServiceLevelObjectivesAPI_ | [**delete_slo**](ServiceLevelObjectivesAPI.md#delete_slo) | **DELETE** /api/v1/slo/{slo_id} | Delete an SLO | +| _DatadogAPIClient::V1::ServiceLevelObjectivesAPI_ | [**delete_slo_timeframe_in_bulk**](ServiceLevelObjectivesAPI.md#delete_slo_timeframe_in_bulk) | **POST** /api/v1/slo/bulk_delete | Bulk Delete SLO Timeframes | +| _DatadogAPIClient::V1::ServiceLevelObjectivesAPI_ | [**get_slo**](ServiceLevelObjectivesAPI.md#get_slo) | **GET** /api/v1/slo/{slo_id} | Get an SLO's details | +| _DatadogAPIClient::V1::ServiceLevelObjectivesAPI_ | [**get_slo_history**](ServiceLevelObjectivesAPI.md#get_slo_history) | **GET** /api/v1/slo/{slo_id}/history | Get an SLO's history | +| _DatadogAPIClient::V1::ServiceLevelObjectivesAPI_ | [**list_slos**](ServiceLevelObjectivesAPI.md#list_slos) | **GET** /api/v1/slo | Get all SLOs | +| _DatadogAPIClient::V1::ServiceLevelObjectivesAPI_ | [**update_slo**](ServiceLevelObjectivesAPI.md#update_slo) | **PUT** /api/v1/slo/{slo_id} | Update an SLO | +| _DatadogAPIClient::V1::SlackIntegrationAPI_ | [**create_slack_integration_channel**](SlackIntegrationAPI.md#create_slack_integration_channel) | **POST** /api/v1/integration/slack/configuration/accounts/{account_name}/channels | Create a Slack integration channel | +| _DatadogAPIClient::V1::SlackIntegrationAPI_ | [**get_slack_integration_channel**](SlackIntegrationAPI.md#get_slack_integration_channel) | **GET** /api/v1/integration/slack/configuration/accounts/{account_name}/channels/{channel_name} | Get a Slack integration channel | +| _DatadogAPIClient::V1::SlackIntegrationAPI_ | [**get_slack_integration_channels**](SlackIntegrationAPI.md#get_slack_integration_channels) | **GET** /api/v1/integration/slack/configuration/accounts/{account_name}/channels | Get all channels in a Slack integration | +| _DatadogAPIClient::V1::SlackIntegrationAPI_ | [**remove_slack_integration_channel**](SlackIntegrationAPI.md#remove_slack_integration_channel) | **DELETE** /api/v1/integration/slack/configuration/accounts/{account_name}/channels/{channel_name} | Remove a Slack integration channel | +| _DatadogAPIClient::V1::SlackIntegrationAPI_ | [**update_slack_integration_channel**](SlackIntegrationAPI.md#update_slack_integration_channel) | **PATCH** /api/v1/integration/slack/configuration/accounts/{account_name}/channels/{channel_name} | Update a Slack integration channel | +| _DatadogAPIClient::V1::SnapshotsAPI_ | [**get_graph_snapshot**](SnapshotsAPI.md#get_graph_snapshot) | **GET** /api/v1/graph/snapshot | Take graph snapshots | +| _DatadogAPIClient::V1::SyntheticsAPI_ | [**create_global_variable**](SyntheticsAPI.md#create_global_variable) | **POST** /api/v1/synthetics/variables | Create a global variable | +| _DatadogAPIClient::V1::SyntheticsAPI_ | [**create_private_location**](SyntheticsAPI.md#create_private_location) | **POST** /api/v1/synthetics/private-locations | Create a private location | +| _DatadogAPIClient::V1::SyntheticsAPI_ | [**create_synthetics_api_test**](SyntheticsAPI.md#create_synthetics_api_test) | **POST** /api/v1/synthetics/tests/api | Create an API test | +| _DatadogAPIClient::V1::SyntheticsAPI_ | [**create_synthetics_browser_test**](SyntheticsAPI.md#create_synthetics_browser_test) | **POST** /api/v1/synthetics/tests/browser | Create a browser test | +| _DatadogAPIClient::V1::SyntheticsAPI_ | [**delete_global_variable**](SyntheticsAPI.md#delete_global_variable) | **DELETE** /api/v1/synthetics/variables/{variable_id} | Delete a global variable | +| _DatadogAPIClient::V1::SyntheticsAPI_ | [**delete_private_location**](SyntheticsAPI.md#delete_private_location) | **DELETE** /api/v1/synthetics/private-locations/{location_id} | Delete a private location | +| _DatadogAPIClient::V1::SyntheticsAPI_ | [**delete_tests**](SyntheticsAPI.md#delete_tests) | **POST** /api/v1/synthetics/tests/delete | Delete tests | +| _DatadogAPIClient::V1::SyntheticsAPI_ | [**edit_global_variable**](SyntheticsAPI.md#edit_global_variable) | **PUT** /api/v1/synthetics/variables/{variable_id} | Edit a global variable | +| _DatadogAPIClient::V1::SyntheticsAPI_ | [**get_api_test**](SyntheticsAPI.md#get_api_test) | **GET** /api/v1/synthetics/tests/api/{public_id} | Get an API test | +| _DatadogAPIClient::V1::SyntheticsAPI_ | [**get_api_test_latest_results**](SyntheticsAPI.md#get_api_test_latest_results) | **GET** /api/v1/synthetics/tests/{public_id}/results | Get an API test's latest results summaries | +| _DatadogAPIClient::V1::SyntheticsAPI_ | [**get_api_test_result**](SyntheticsAPI.md#get_api_test_result) | **GET** /api/v1/synthetics/tests/{public_id}/results/{result_id} | Get an API test result | +| _DatadogAPIClient::V1::SyntheticsAPI_ | [**get_browser_test**](SyntheticsAPI.md#get_browser_test) | **GET** /api/v1/synthetics/tests/browser/{public_id} | Get a browser test | +| _DatadogAPIClient::V1::SyntheticsAPI_ | [**get_browser_test_latest_results**](SyntheticsAPI.md#get_browser_test_latest_results) | **GET** /api/v1/synthetics/tests/browser/{public_id}/results | Get a browser test's latest results summaries | +| _DatadogAPIClient::V1::SyntheticsAPI_ | [**get_browser_test_result**](SyntheticsAPI.md#get_browser_test_result) | **GET** /api/v1/synthetics/tests/browser/{public_id}/results/{result_id} | Get a browser test result | +| _DatadogAPIClient::V1::SyntheticsAPI_ | [**get_global_variable**](SyntheticsAPI.md#get_global_variable) | **GET** /api/v1/synthetics/variables/{variable_id} | Get a global variable | +| _DatadogAPIClient::V1::SyntheticsAPI_ | [**get_private_location**](SyntheticsAPI.md#get_private_location) | **GET** /api/v1/synthetics/private-locations/{location_id} | Get a private location | +| _DatadogAPIClient::V1::SyntheticsAPI_ | [**get_synthetics_ci_batch**](SyntheticsAPI.md#get_synthetics_ci_batch) | **GET** /api/v1/synthetics/ci/batch/{batch_id} | Get details of batch | +| _DatadogAPIClient::V1::SyntheticsAPI_ | [**get_test**](SyntheticsAPI.md#get_test) | **GET** /api/v1/synthetics/tests/{public_id} | Get a test configuration | +| _DatadogAPIClient::V1::SyntheticsAPI_ | [**list_global_variables**](SyntheticsAPI.md#list_global_variables) | **GET** /api/v1/synthetics/variables | Get all global variables | +| _DatadogAPIClient::V1::SyntheticsAPI_ | [**list_locations**](SyntheticsAPI.md#list_locations) | **GET** /api/v1/synthetics/locations | Get all locations (public and private) | +| _DatadogAPIClient::V1::SyntheticsAPI_ | [**list_tests**](SyntheticsAPI.md#list_tests) | **GET** /api/v1/synthetics/tests | Get the list of all tests | +| _DatadogAPIClient::V1::SyntheticsAPI_ | [**trigger_ci_tests**](SyntheticsAPI.md#trigger_ci_tests) | **POST** /api/v1/synthetics/tests/trigger/ci | Trigger tests from CI/CD pipelines | +| _DatadogAPIClient::V1::SyntheticsAPI_ | [**update_api_test**](SyntheticsAPI.md#update_api_test) | **PUT** /api/v1/synthetics/tests/api/{public_id} | Edit an API test | +| _DatadogAPIClient::V1::SyntheticsAPI_ | [**update_browser_test**](SyntheticsAPI.md#update_browser_test) | **PUT** /api/v1/synthetics/tests/browser/{public_id} | Edit a browser test | +| _DatadogAPIClient::V1::SyntheticsAPI_ | [**update_private_location**](SyntheticsAPI.md#update_private_location) | **PUT** /api/v1/synthetics/private-locations/{location_id} | Edit a private location | +| _DatadogAPIClient::V1::SyntheticsAPI_ | [**update_test_pause_status**](SyntheticsAPI.md#update_test_pause_status) | **PUT** /api/v1/synthetics/tests/{public_id}/status | Pause or start a test | +| _DatadogAPIClient::V1::TagsAPI_ | [**create_host_tags**](TagsAPI.md#create_host_tags) | **POST** /api/v1/tags/hosts/{host_name} | Add tags to a host | +| _DatadogAPIClient::V1::TagsAPI_ | [**delete_host_tags**](TagsAPI.md#delete_host_tags) | **DELETE** /api/v1/tags/hosts/{host_name} | Remove host tags | +| _DatadogAPIClient::V1::TagsAPI_ | [**get_host_tags**](TagsAPI.md#get_host_tags) | **GET** /api/v1/tags/hosts/{host_name} | Get host tags | +| _DatadogAPIClient::V1::TagsAPI_ | [**list_host_tags**](TagsAPI.md#list_host_tags) | **GET** /api/v1/tags/hosts | Get Tags | +| _DatadogAPIClient::V1::TagsAPI_ | [**update_host_tags**](TagsAPI.md#update_host_tags) | **PUT** /api/v1/tags/hosts/{host_name} | Update host tags | +| _DatadogAPIClient::V1::UsageMeteringAPI_ | [**get_daily_custom_reports**](UsageMeteringAPI.md#get_daily_custom_reports) | **GET** /api/v1/daily_custom_reports | Get the list of available daily custom reports | +| _DatadogAPIClient::V1::UsageMeteringAPI_ | [**get_incident_management**](UsageMeteringAPI.md#get_incident_management) | **GET** /api/v1/usage/incident-management | Get hourly usage for incident management | +| _DatadogAPIClient::V1::UsageMeteringAPI_ | [**get_ingested_spans**](UsageMeteringAPI.md#get_ingested_spans) | **GET** /api/v1/usage/ingested-spans | Get hourly usage for ingested spans | +| _DatadogAPIClient::V1::UsageMeteringAPI_ | [**get_monthly_custom_reports**](UsageMeteringAPI.md#get_monthly_custom_reports) | **GET** /api/v1/monthly_custom_reports | Get the list of available monthly custom reports | +| _DatadogAPIClient::V1::UsageMeteringAPI_ | [**get_specified_daily_custom_reports**](UsageMeteringAPI.md#get_specified_daily_custom_reports) | **GET** /api/v1/daily_custom_reports/{report_id} | Get specified daily custom reports | +| _DatadogAPIClient::V1::UsageMeteringAPI_ | [**get_specified_monthly_custom_reports**](UsageMeteringAPI.md#get_specified_monthly_custom_reports) | **GET** /api/v1/monthly_custom_reports/{report_id} | Get specified monthly custom reports | +| _DatadogAPIClient::V1::UsageMeteringAPI_ | [**get_usage_analyzed_logs**](UsageMeteringAPI.md#get_usage_analyzed_logs) | **GET** /api/v1/usage/analyzed_logs | Get hourly usage for analyzed logs | +| _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 | +| _DatadogAPIClient::V1::UsageMeteringAPI_ | [**get_usage_logs**](UsageMeteringAPI.md#get_usage_logs) | **GET** /api/v1/usage/logs | Get hourly usage for Logs | +| _DatadogAPIClient::V1::UsageMeteringAPI_ | [**get_usage_logs_by_index**](UsageMeteringAPI.md#get_usage_logs_by_index) | **GET** /api/v1/usage/logs_by_index | Get hourly usage for Logs by Index | +| _DatadogAPIClient::V1::UsageMeteringAPI_ | [**get_usage_logs_by_retention**](UsageMeteringAPI.md#get_usage_logs_by_retention) | **GET** /api/v1/usage/logs-by-retention | Get hourly logs usage by retention | +| _DatadogAPIClient::V1::UsageMeteringAPI_ | [**get_usage_network_flows**](UsageMeteringAPI.md#get_usage_network_flows) | **GET** /api/v1/usage/network_flows | Get hourly usage for Network Flows | +| _DatadogAPIClient::V1::UsageMeteringAPI_ | [**get_usage_network_hosts**](UsageMeteringAPI.md#get_usage_network_hosts) | **GET** /api/v1/usage/network_hosts | Get hourly usage for Network Hosts | +| _DatadogAPIClient::V1::UsageMeteringAPI_ | [**get_usage_profiling**](UsageMeteringAPI.md#get_usage_profiling) | **GET** /api/v1/usage/profiling | Get hourly usage for profiled hosts | +| _DatadogAPIClient::V1::UsageMeteringAPI_ | [**get_usage_rum_sessions**](UsageMeteringAPI.md#get_usage_rum_sessions) | **GET** /api/v1/usage/rum_sessions | Get hourly usage for RUM Sessions | +| _DatadogAPIClient::V1::UsageMeteringAPI_ | [**get_usage_sds**](UsageMeteringAPI.md#get_usage_sds) | **GET** /api/v1/usage/sds | Get hourly usage for Sensitive Data Scanner | +| _DatadogAPIClient::V1::UsageMeteringAPI_ | [**get_usage_snmp**](UsageMeteringAPI.md#get_usage_snmp) | **GET** /api/v1/usage/snmp | Get hourly usage for SNMP devices | +| _DatadogAPIClient::V1::UsageMeteringAPI_ | [**get_usage_summary**](UsageMeteringAPI.md#get_usage_summary) | **GET** /api/v1/usage/summary | Get usage across your multi-org account | +| _DatadogAPIClient::V1::UsageMeteringAPI_ | [**get_usage_synthetics**](UsageMeteringAPI.md#get_usage_synthetics) | **GET** /api/v1/usage/synthetics | Get hourly usage for Synthetics Checks | +| _DatadogAPIClient::V1::UsageMeteringAPI_ | [**get_usage_synthetics_api**](UsageMeteringAPI.md#get_usage_synthetics_api) | **GET** /api/v1/usage/synthetics_api | Get hourly usage for Synthetics API Checks | +| _DatadogAPIClient::V1::UsageMeteringAPI_ | [**get_usage_synthetics_browser**](UsageMeteringAPI.md#get_usage_synthetics_browser) | **GET** /api/v1/usage/synthetics_browser | Get hourly usage for Synthetics Browser Checks | +| _DatadogAPIClient::V1::UsageMeteringAPI_ | [**get_usage_timeseries**](UsageMeteringAPI.md#get_usage_timeseries) | **GET** /api/v1/usage/timeseries | Get hourly usage for custom metrics | +| _DatadogAPIClient::V1::UsageMeteringAPI_ | [**get_usage_top_avg_metrics**](UsageMeteringAPI.md#get_usage_top_avg_metrics) | **GET** /api/v1/usage/top_avg_metrics | Get all custom metrics by hourly average | +| _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) - - [DatadogAPIClient::V1::AWSAccount](AWSAccount.md) - - [DatadogAPIClient::V1::AWSAccountAndLambdaRequest](AWSAccountAndLambdaRequest.md) - - [DatadogAPIClient::V1::AWSAccountCreateResponse](AWSAccountCreateResponse.md) - - [DatadogAPIClient::V1::AWSAccountDeleteRequest](AWSAccountDeleteRequest.md) - - [DatadogAPIClient::V1::AWSAccountListResponse](AWSAccountListResponse.md) - - [DatadogAPIClient::V1::AWSLogsAsyncError](AWSLogsAsyncError.md) - - [DatadogAPIClient::V1::AWSLogsAsyncResponse](AWSLogsAsyncResponse.md) - - [DatadogAPIClient::V1::AWSLogsLambda](AWSLogsLambda.md) - - [DatadogAPIClient::V1::AWSLogsListResponse](AWSLogsListResponse.md) - - [DatadogAPIClient::V1::AWSLogsListServicesResponse](AWSLogsListServicesResponse.md) - - [DatadogAPIClient::V1::AWSLogsServicesRequest](AWSLogsServicesRequest.md) - - [DatadogAPIClient::V1::AWSNamespace](AWSNamespace.md) - - [DatadogAPIClient::V1::AWSTagFilter](AWSTagFilter.md) - - [DatadogAPIClient::V1::AWSTagFilterCreateRequest](AWSTagFilterCreateRequest.md) - - [DatadogAPIClient::V1::AWSTagFilterDeleteRequest](AWSTagFilterDeleteRequest.md) - - [DatadogAPIClient::V1::AWSTagFilterListResponse](AWSTagFilterListResponse.md) - - [DatadogAPIClient::V1::AccessRole](AccessRole.md) - - [DatadogAPIClient::V1::AlertGraphWidgetDefinition](AlertGraphWidgetDefinition.md) - - [DatadogAPIClient::V1::AlertGraphWidgetDefinitionType](AlertGraphWidgetDefinitionType.md) - - [DatadogAPIClient::V1::AlertValueWidgetDefinition](AlertValueWidgetDefinition.md) - - [DatadogAPIClient::V1::AlertValueWidgetDefinitionType](AlertValueWidgetDefinitionType.md) - - [DatadogAPIClient::V1::ApiKey](ApiKey.md) - - [DatadogAPIClient::V1::ApiKeyListResponse](ApiKeyListResponse.md) - - [DatadogAPIClient::V1::ApiKeyResponse](ApiKeyResponse.md) - - [DatadogAPIClient::V1::ApmStatsQueryColumnType](ApmStatsQueryColumnType.md) - - [DatadogAPIClient::V1::ApmStatsQueryDefinition](ApmStatsQueryDefinition.md) - - [DatadogAPIClient::V1::ApmStatsQueryRowType](ApmStatsQueryRowType.md) - - [DatadogAPIClient::V1::ApplicationKey](ApplicationKey.md) - - [DatadogAPIClient::V1::ApplicationKeyListResponse](ApplicationKeyListResponse.md) - - [DatadogAPIClient::V1::ApplicationKeyResponse](ApplicationKeyResponse.md) - - [DatadogAPIClient::V1::AuthenticationValidationResponse](AuthenticationValidationResponse.md) - - [DatadogAPIClient::V1::AzureAccount](AzureAccount.md) - - [DatadogAPIClient::V1::CancelDowntimesByScopeRequest](CancelDowntimesByScopeRequest.md) - - [DatadogAPIClient::V1::CanceledDowntimesIds](CanceledDowntimesIds.md) - - [DatadogAPIClient::V1::ChangeWidgetDefinition](ChangeWidgetDefinition.md) - - [DatadogAPIClient::V1::ChangeWidgetDefinitionType](ChangeWidgetDefinitionType.md) - - [DatadogAPIClient::V1::ChangeWidgetRequest](ChangeWidgetRequest.md) - - [DatadogAPIClient::V1::CheckCanDeleteMonitorResponse](CheckCanDeleteMonitorResponse.md) - - [DatadogAPIClient::V1::CheckCanDeleteMonitorResponseData](CheckCanDeleteMonitorResponseData.md) - - [DatadogAPIClient::V1::CheckCanDeleteSLOResponse](CheckCanDeleteSLOResponse.md) - - [DatadogAPIClient::V1::CheckCanDeleteSLOResponseData](CheckCanDeleteSLOResponseData.md) - - [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) - - [DatadogAPIClient::V1::DeletedMonitor](DeletedMonitor.md) - - [DatadogAPIClient::V1::DistributionWidgetDefinition](DistributionWidgetDefinition.md) - - [DatadogAPIClient::V1::DistributionWidgetDefinitionType](DistributionWidgetDefinitionType.md) - - [DatadogAPIClient::V1::DistributionWidgetRequest](DistributionWidgetRequest.md) - - [DatadogAPIClient::V1::DistributionWidgetXAxis](DistributionWidgetXAxis.md) - - [DatadogAPIClient::V1::DistributionWidgetYAxis](DistributionWidgetYAxis.md) - - [DatadogAPIClient::V1::Downtime](Downtime.md) - - [DatadogAPIClient::V1::DowntimeChild](DowntimeChild.md) - - [DatadogAPIClient::V1::DowntimeRecurrence](DowntimeRecurrence.md) - - [DatadogAPIClient::V1::Event](Event.md) - - [DatadogAPIClient::V1::EventAlertType](EventAlertType.md) - - [DatadogAPIClient::V1::EventCreateRequest](EventCreateRequest.md) - - [DatadogAPIClient::V1::EventCreateResponse](EventCreateResponse.md) - - [DatadogAPIClient::V1::EventListResponse](EventListResponse.md) - - [DatadogAPIClient::V1::EventPriority](EventPriority.md) - - [DatadogAPIClient::V1::EventQueryDefinition](EventQueryDefinition.md) - - [DatadogAPIClient::V1::EventResponse](EventResponse.md) - - [DatadogAPIClient::V1::EventStreamWidgetDefinition](EventStreamWidgetDefinition.md) - - [DatadogAPIClient::V1::EventStreamWidgetDefinitionType](EventStreamWidgetDefinitionType.md) - - [DatadogAPIClient::V1::EventTimelineWidgetDefinition](EventTimelineWidgetDefinition.md) - - [DatadogAPIClient::V1::EventTimelineWidgetDefinitionType](EventTimelineWidgetDefinitionType.md) - - [DatadogAPIClient::V1::FormulaAndFunctionApmDependencyStatName](FormulaAndFunctionApmDependencyStatName.md) - - [DatadogAPIClient::V1::FormulaAndFunctionApmDependencyStatsDataSource](FormulaAndFunctionApmDependencyStatsDataSource.md) - - [DatadogAPIClient::V1::FormulaAndFunctionApmDependencyStatsQueryDefinition](FormulaAndFunctionApmDependencyStatsQueryDefinition.md) - - [DatadogAPIClient::V1::FormulaAndFunctionApmResourceStatName](FormulaAndFunctionApmResourceStatName.md) - - [DatadogAPIClient::V1::FormulaAndFunctionApmResourceStatsDataSource](FormulaAndFunctionApmResourceStatsDataSource.md) - - [DatadogAPIClient::V1::FormulaAndFunctionApmResourceStatsQueryDefinition](FormulaAndFunctionApmResourceStatsQueryDefinition.md) - - [DatadogAPIClient::V1::FormulaAndFunctionEventAggregation](FormulaAndFunctionEventAggregation.md) - - [DatadogAPIClient::V1::FormulaAndFunctionEventQueryDefinition](FormulaAndFunctionEventQueryDefinition.md) - - [DatadogAPIClient::V1::FormulaAndFunctionEventQueryDefinitionCompute](FormulaAndFunctionEventQueryDefinitionCompute.md) - - [DatadogAPIClient::V1::FormulaAndFunctionEventQueryDefinitionSearch](FormulaAndFunctionEventQueryDefinitionSearch.md) - - [DatadogAPIClient::V1::FormulaAndFunctionEventQueryGroupBy](FormulaAndFunctionEventQueryGroupBy.md) - - [DatadogAPIClient::V1::FormulaAndFunctionEventQueryGroupBySort](FormulaAndFunctionEventQueryGroupBySort.md) - - [DatadogAPIClient::V1::FormulaAndFunctionEventsDataSource](FormulaAndFunctionEventsDataSource.md) - - [DatadogAPIClient::V1::FormulaAndFunctionMetricAggregation](FormulaAndFunctionMetricAggregation.md) - - [DatadogAPIClient::V1::FormulaAndFunctionMetricDataSource](FormulaAndFunctionMetricDataSource.md) - - [DatadogAPIClient::V1::FormulaAndFunctionMetricQueryDefinition](FormulaAndFunctionMetricQueryDefinition.md) - - [DatadogAPIClient::V1::FormulaAndFunctionProcessQueryDataSource](FormulaAndFunctionProcessQueryDataSource.md) - - [DatadogAPIClient::V1::FormulaAndFunctionProcessQueryDefinition](FormulaAndFunctionProcessQueryDefinition.md) - - [DatadogAPIClient::V1::FormulaAndFunctionQueryDefinition](FormulaAndFunctionQueryDefinition.md) - - [DatadogAPIClient::V1::FormulaAndFunctionResponseFormat](FormulaAndFunctionResponseFormat.md) - - [DatadogAPIClient::V1::FreeTextWidgetDefinition](FreeTextWidgetDefinition.md) - - [DatadogAPIClient::V1::FreeTextWidgetDefinitionType](FreeTextWidgetDefinitionType.md) - - [DatadogAPIClient::V1::FunnelQuery](FunnelQuery.md) - - [DatadogAPIClient::V1::FunnelRequestType](FunnelRequestType.md) - - [DatadogAPIClient::V1::FunnelSource](FunnelSource.md) - - [DatadogAPIClient::V1::FunnelWidgetDefinition](FunnelWidgetDefinition.md) - - [DatadogAPIClient::V1::FunnelWidgetDefinitionType](FunnelWidgetDefinitionType.md) - - [DatadogAPIClient::V1::FunnelWidgetRequest](FunnelWidgetRequest.md) - - [DatadogAPIClient::V1::GCPAccount](GCPAccount.md) - - [DatadogAPIClient::V1::GeomapWidgetDefinition](GeomapWidgetDefinition.md) - - [DatadogAPIClient::V1::GeomapWidgetDefinitionStyle](GeomapWidgetDefinitionStyle.md) - - [DatadogAPIClient::V1::GeomapWidgetDefinitionType](GeomapWidgetDefinitionType.md) - - [DatadogAPIClient::V1::GeomapWidgetDefinitionView](GeomapWidgetDefinitionView.md) - - [DatadogAPIClient::V1::GeomapWidgetRequest](GeomapWidgetRequest.md) - - [DatadogAPIClient::V1::GraphSnapshot](GraphSnapshot.md) - - [DatadogAPIClient::V1::GroupWidgetDefinition](GroupWidgetDefinition.md) - - [DatadogAPIClient::V1::GroupWidgetDefinitionType](GroupWidgetDefinitionType.md) - - [DatadogAPIClient::V1::HTTPLogError](HTTPLogError.md) - - [DatadogAPIClient::V1::HTTPLogItem](HTTPLogItem.md) - - [DatadogAPIClient::V1::HTTPMethod](HTTPMethod.md) - - [DatadogAPIClient::V1::HeatMapWidgetDefinition](HeatMapWidgetDefinition.md) - - [DatadogAPIClient::V1::HeatMapWidgetDefinitionType](HeatMapWidgetDefinitionType.md) - - [DatadogAPIClient::V1::HeatMapWidgetRequest](HeatMapWidgetRequest.md) - - [DatadogAPIClient::V1::Host](Host.md) - - [DatadogAPIClient::V1::HostListResponse](HostListResponse.md) - - [DatadogAPIClient::V1::HostMapRequest](HostMapRequest.md) - - [DatadogAPIClient::V1::HostMapWidgetDefinition](HostMapWidgetDefinition.md) - - [DatadogAPIClient::V1::HostMapWidgetDefinitionRequests](HostMapWidgetDefinitionRequests.md) - - [DatadogAPIClient::V1::HostMapWidgetDefinitionStyle](HostMapWidgetDefinitionStyle.md) - - [DatadogAPIClient::V1::HostMapWidgetDefinitionType](HostMapWidgetDefinitionType.md) - - [DatadogAPIClient::V1::HostMeta](HostMeta.md) - - [DatadogAPIClient::V1::HostMetrics](HostMetrics.md) - - [DatadogAPIClient::V1::HostMuteResponse](HostMuteResponse.md) - - [DatadogAPIClient::V1::HostMuteSettings](HostMuteSettings.md) - - [DatadogAPIClient::V1::HostTags](HostTags.md) - - [DatadogAPIClient::V1::HostTotals](HostTotals.md) - - [DatadogAPIClient::V1::IFrameWidgetDefinition](IFrameWidgetDefinition.md) - - [DatadogAPIClient::V1::IFrameWidgetDefinitionType](IFrameWidgetDefinitionType.md) - - [DatadogAPIClient::V1::IPPrefixesAPI](IPPrefixesAPI.md) - - [DatadogAPIClient::V1::IPPrefixesAPM](IPPrefixesAPM.md) - - [DatadogAPIClient::V1::IPPrefixesAgents](IPPrefixesAgents.md) - - [DatadogAPIClient::V1::IPPrefixesLogs](IPPrefixesLogs.md) - - [DatadogAPIClient::V1::IPPrefixesProcess](IPPrefixesProcess.md) - - [DatadogAPIClient::V1::IPPrefixesSynthetics](IPPrefixesSynthetics.md) - - [DatadogAPIClient::V1::IPPrefixesWebhooks](IPPrefixesWebhooks.md) - - [DatadogAPIClient::V1::IPRanges](IPRanges.md) - - [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) - - [DatadogAPIClient::V1::LogQueryDefinitionSearch](LogQueryDefinitionSearch.md) - - [DatadogAPIClient::V1::LogStreamWidgetDefinition](LogStreamWidgetDefinition.md) - - [DatadogAPIClient::V1::LogStreamWidgetDefinitionType](LogStreamWidgetDefinitionType.md) - - [DatadogAPIClient::V1::LogsAPIError](LogsAPIError.md) - - [DatadogAPIClient::V1::LogsAPIErrorResponse](LogsAPIErrorResponse.md) - - [DatadogAPIClient::V1::LogsArithmeticProcessor](LogsArithmeticProcessor.md) - - [DatadogAPIClient::V1::LogsArithmeticProcessorType](LogsArithmeticProcessorType.md) - - [DatadogAPIClient::V1::LogsAttributeRemapper](LogsAttributeRemapper.md) - - [DatadogAPIClient::V1::LogsAttributeRemapperType](LogsAttributeRemapperType.md) - - [DatadogAPIClient::V1::LogsByRetention](LogsByRetention.md) - - [DatadogAPIClient::V1::LogsByRetentionMonthlyUsage](LogsByRetentionMonthlyUsage.md) - - [DatadogAPIClient::V1::LogsByRetentionOrgUsage](LogsByRetentionOrgUsage.md) - - [DatadogAPIClient::V1::LogsByRetentionOrgs](LogsByRetentionOrgs.md) - - [DatadogAPIClient::V1::LogsCategoryProcessor](LogsCategoryProcessor.md) - - [DatadogAPIClient::V1::LogsCategoryProcessorCategory](LogsCategoryProcessorCategory.md) - - [DatadogAPIClient::V1::LogsCategoryProcessorType](LogsCategoryProcessorType.md) - - [DatadogAPIClient::V1::LogsDateRemapper](LogsDateRemapper.md) - - [DatadogAPIClient::V1::LogsDateRemapperType](LogsDateRemapperType.md) - - [DatadogAPIClient::V1::LogsExclusion](LogsExclusion.md) - - [DatadogAPIClient::V1::LogsExclusionFilter](LogsExclusionFilter.md) - - [DatadogAPIClient::V1::LogsFilter](LogsFilter.md) - - [DatadogAPIClient::V1::LogsGeoIPParser](LogsGeoIPParser.md) - - [DatadogAPIClient::V1::LogsGeoIPParserType](LogsGeoIPParserType.md) - - [DatadogAPIClient::V1::LogsGrokParser](LogsGrokParser.md) - - [DatadogAPIClient::V1::LogsGrokParserRules](LogsGrokParserRules.md) - - [DatadogAPIClient::V1::LogsGrokParserType](LogsGrokParserType.md) - - [DatadogAPIClient::V1::LogsIndex](LogsIndex.md) - - [DatadogAPIClient::V1::LogsIndexListResponse](LogsIndexListResponse.md) - - [DatadogAPIClient::V1::LogsIndexUpdateRequest](LogsIndexUpdateRequest.md) - - [DatadogAPIClient::V1::LogsIndexesOrder](LogsIndexesOrder.md) - - [DatadogAPIClient::V1::LogsListRequest](LogsListRequest.md) - - [DatadogAPIClient::V1::LogsListRequestTime](LogsListRequestTime.md) - - [DatadogAPIClient::V1::LogsListResponse](LogsListResponse.md) - - [DatadogAPIClient::V1::LogsLookupProcessor](LogsLookupProcessor.md) - - [DatadogAPIClient::V1::LogsLookupProcessorType](LogsLookupProcessorType.md) - - [DatadogAPIClient::V1::LogsMessageRemapper](LogsMessageRemapper.md) - - [DatadogAPIClient::V1::LogsMessageRemapperType](LogsMessageRemapperType.md) - - [DatadogAPIClient::V1::LogsPipeline](LogsPipeline.md) - - [DatadogAPIClient::V1::LogsPipelineProcessor](LogsPipelineProcessor.md) - - [DatadogAPIClient::V1::LogsPipelineProcessorType](LogsPipelineProcessorType.md) - - [DatadogAPIClient::V1::LogsPipelinesOrder](LogsPipelinesOrder.md) - - [DatadogAPIClient::V1::LogsProcessor](LogsProcessor.md) - - [DatadogAPIClient::V1::LogsQueryCompute](LogsQueryCompute.md) - - [DatadogAPIClient::V1::LogsRetentionAggSumUsage](LogsRetentionAggSumUsage.md) - - [DatadogAPIClient::V1::LogsRetentionSumUsage](LogsRetentionSumUsage.md) - - [DatadogAPIClient::V1::LogsServiceRemapper](LogsServiceRemapper.md) - - [DatadogAPIClient::V1::LogsServiceRemapperType](LogsServiceRemapperType.md) - - [DatadogAPIClient::V1::LogsSort](LogsSort.md) - - [DatadogAPIClient::V1::LogsStatusRemapper](LogsStatusRemapper.md) - - [DatadogAPIClient::V1::LogsStatusRemapperType](LogsStatusRemapperType.md) - - [DatadogAPIClient::V1::LogsStringBuilderProcessor](LogsStringBuilderProcessor.md) - - [DatadogAPIClient::V1::LogsStringBuilderProcessorType](LogsStringBuilderProcessorType.md) - - [DatadogAPIClient::V1::LogsTraceRemapper](LogsTraceRemapper.md) - - [DatadogAPIClient::V1::LogsTraceRemapperType](LogsTraceRemapperType.md) - - [DatadogAPIClient::V1::LogsURLParser](LogsURLParser.md) - - [DatadogAPIClient::V1::LogsURLParserType](LogsURLParserType.md) - - [DatadogAPIClient::V1::LogsUserAgentParser](LogsUserAgentParser.md) - - [DatadogAPIClient::V1::LogsUserAgentParserType](LogsUserAgentParserType.md) - - [DatadogAPIClient::V1::MetricContentEncoding](MetricContentEncoding.md) - - [DatadogAPIClient::V1::MetricMetadata](MetricMetadata.md) - - [DatadogAPIClient::V1::MetricSearchResponse](MetricSearchResponse.md) - - [DatadogAPIClient::V1::MetricSearchResponseResults](MetricSearchResponseResults.md) - - [DatadogAPIClient::V1::MetricsListResponse](MetricsListResponse.md) - - [DatadogAPIClient::V1::MetricsPayload](MetricsPayload.md) - - [DatadogAPIClient::V1::MetricsQueryMetadata](MetricsQueryMetadata.md) - - [DatadogAPIClient::V1::MetricsQueryResponse](MetricsQueryResponse.md) - - [DatadogAPIClient::V1::MetricsQueryUnit](MetricsQueryUnit.md) - - [DatadogAPIClient::V1::Monitor](Monitor.md) - - [DatadogAPIClient::V1::MonitorDeviceID](MonitorDeviceID.md) - - [DatadogAPIClient::V1::MonitorGroupSearchResponse](MonitorGroupSearchResponse.md) - - [DatadogAPIClient::V1::MonitorGroupSearchResponseCounts](MonitorGroupSearchResponseCounts.md) - - [DatadogAPIClient::V1::MonitorGroupSearchResult](MonitorGroupSearchResult.md) - - [DatadogAPIClient::V1::MonitorOptions](MonitorOptions.md) - - [DatadogAPIClient::V1::MonitorOptionsAggregation](MonitorOptionsAggregation.md) - - [DatadogAPIClient::V1::MonitorOverallStates](MonitorOverallStates.md) - - [DatadogAPIClient::V1::MonitorRenotifyStatusType](MonitorRenotifyStatusType.md) - - [DatadogAPIClient::V1::MonitorSearchResponse](MonitorSearchResponse.md) - - [DatadogAPIClient::V1::MonitorSearchResponseCounts](MonitorSearchResponseCounts.md) - - [DatadogAPIClient::V1::MonitorSearchResponseMetadata](MonitorSearchResponseMetadata.md) - - [DatadogAPIClient::V1::MonitorSearchResult](MonitorSearchResult.md) - - [DatadogAPIClient::V1::MonitorSearchResultNotification](MonitorSearchResultNotification.md) - - [DatadogAPIClient::V1::MonitorState](MonitorState.md) - - [DatadogAPIClient::V1::MonitorStateGroup](MonitorStateGroup.md) - - [DatadogAPIClient::V1::MonitorSummaryWidgetDefinition](MonitorSummaryWidgetDefinition.md) - - [DatadogAPIClient::V1::MonitorSummaryWidgetDefinitionType](MonitorSummaryWidgetDefinitionType.md) - - [DatadogAPIClient::V1::MonitorThresholdWindowOptions](MonitorThresholdWindowOptions.md) - - [DatadogAPIClient::V1::MonitorThresholds](MonitorThresholds.md) - - [DatadogAPIClient::V1::MonitorType](MonitorType.md) - - [DatadogAPIClient::V1::MonitorUpdateRequest](MonitorUpdateRequest.md) - - [DatadogAPIClient::V1::NoteWidgetDefinition](NoteWidgetDefinition.md) - - [DatadogAPIClient::V1::NoteWidgetDefinitionType](NoteWidgetDefinitionType.md) - - [DatadogAPIClient::V1::NotebookAbsoluteTime](NotebookAbsoluteTime.md) - - [DatadogAPIClient::V1::NotebookAuthor](NotebookAuthor.md) - - [DatadogAPIClient::V1::NotebookCellCreateRequest](NotebookCellCreateRequest.md) - - [DatadogAPIClient::V1::NotebookCellCreateRequestAttributes](NotebookCellCreateRequestAttributes.md) - - [DatadogAPIClient::V1::NotebookCellResourceType](NotebookCellResourceType.md) - - [DatadogAPIClient::V1::NotebookCellResponse](NotebookCellResponse.md) - - [DatadogAPIClient::V1::NotebookCellResponseAttributes](NotebookCellResponseAttributes.md) - - [DatadogAPIClient::V1::NotebookCellTime](NotebookCellTime.md) - - [DatadogAPIClient::V1::NotebookCellUpdateRequest](NotebookCellUpdateRequest.md) - - [DatadogAPIClient::V1::NotebookCellUpdateRequestAttributes](NotebookCellUpdateRequestAttributes.md) - - [DatadogAPIClient::V1::NotebookCreateData](NotebookCreateData.md) - - [DatadogAPIClient::V1::NotebookCreateDataAttributes](NotebookCreateDataAttributes.md) - - [DatadogAPIClient::V1::NotebookCreateRequest](NotebookCreateRequest.md) - - [DatadogAPIClient::V1::NotebookDistributionCellAttributes](NotebookDistributionCellAttributes.md) - - [DatadogAPIClient::V1::NotebookGlobalTime](NotebookGlobalTime.md) - - [DatadogAPIClient::V1::NotebookGraphSize](NotebookGraphSize.md) - - [DatadogAPIClient::V1::NotebookHeatMapCellAttributes](NotebookHeatMapCellAttributes.md) - - [DatadogAPIClient::V1::NotebookLogStreamCellAttributes](NotebookLogStreamCellAttributes.md) - - [DatadogAPIClient::V1::NotebookMarkdownCellAttributes](NotebookMarkdownCellAttributes.md) - - [DatadogAPIClient::V1::NotebookMarkdownCellDefinition](NotebookMarkdownCellDefinition.md) - - [DatadogAPIClient::V1::NotebookMarkdownCellDefinitionType](NotebookMarkdownCellDefinitionType.md) - - [DatadogAPIClient::V1::NotebookMetadata](NotebookMetadata.md) - - [DatadogAPIClient::V1::NotebookMetadataType](NotebookMetadataType.md) - - [DatadogAPIClient::V1::NotebookRelativeTime](NotebookRelativeTime.md) - - [DatadogAPIClient::V1::NotebookResourceType](NotebookResourceType.md) - - [DatadogAPIClient::V1::NotebookResponse](NotebookResponse.md) - - [DatadogAPIClient::V1::NotebookResponseData](NotebookResponseData.md) - - [DatadogAPIClient::V1::NotebookResponseDataAttributes](NotebookResponseDataAttributes.md) - - [DatadogAPIClient::V1::NotebookSplitBy](NotebookSplitBy.md) - - [DatadogAPIClient::V1::NotebookStatus](NotebookStatus.md) - - [DatadogAPIClient::V1::NotebookTimeseriesCellAttributes](NotebookTimeseriesCellAttributes.md) - - [DatadogAPIClient::V1::NotebookToplistCellAttributes](NotebookToplistCellAttributes.md) - - [DatadogAPIClient::V1::NotebookUpdateCell](NotebookUpdateCell.md) - - [DatadogAPIClient::V1::NotebookUpdateData](NotebookUpdateData.md) - - [DatadogAPIClient::V1::NotebookUpdateDataAttributes](NotebookUpdateDataAttributes.md) - - [DatadogAPIClient::V1::NotebookUpdateRequest](NotebookUpdateRequest.md) - - [DatadogAPIClient::V1::NotebooksResponse](NotebooksResponse.md) - - [DatadogAPIClient::V1::NotebooksResponseData](NotebooksResponseData.md) - - [DatadogAPIClient::V1::NotebooksResponseDataAttributes](NotebooksResponseDataAttributes.md) - - [DatadogAPIClient::V1::NotebooksResponseMeta](NotebooksResponseMeta.md) - - [DatadogAPIClient::V1::NotebooksResponsePage](NotebooksResponsePage.md) - - [DatadogAPIClient::V1::Organization](Organization.md) - - [DatadogAPIClient::V1::OrganizationBilling](OrganizationBilling.md) - - [DatadogAPIClient::V1::OrganizationCreateBody](OrganizationCreateBody.md) - - [DatadogAPIClient::V1::OrganizationCreateResponse](OrganizationCreateResponse.md) - - [DatadogAPIClient::V1::OrganizationListResponse](OrganizationListResponse.md) - - [DatadogAPIClient::V1::OrganizationResponse](OrganizationResponse.md) - - [DatadogAPIClient::V1::OrganizationSettings](OrganizationSettings.md) - - [DatadogAPIClient::V1::OrganizationSettingsSaml](OrganizationSettingsSaml.md) - - [DatadogAPIClient::V1::OrganizationSettingsSamlAutocreateUsersDomains](OrganizationSettingsSamlAutocreateUsersDomains.md) - - [DatadogAPIClient::V1::OrganizationSettingsSamlIdpInitiatedLogin](OrganizationSettingsSamlIdpInitiatedLogin.md) - - [DatadogAPIClient::V1::OrganizationSettingsSamlStrictMode](OrganizationSettingsSamlStrictMode.md) - - [DatadogAPIClient::V1::OrganizationSubscription](OrganizationSubscription.md) - - [DatadogAPIClient::V1::PagerDutyService](PagerDutyService.md) - - [DatadogAPIClient::V1::PagerDutyServiceKey](PagerDutyServiceKey.md) - - [DatadogAPIClient::V1::PagerDutyServiceName](PagerDutyServiceName.md) - - [DatadogAPIClient::V1::Pagination](Pagination.md) - - [DatadogAPIClient::V1::ProcessQueryDefinition](ProcessQueryDefinition.md) - - [DatadogAPIClient::V1::QuerySortOrder](QuerySortOrder.md) - - [DatadogAPIClient::V1::QueryValueWidgetDefinition](QueryValueWidgetDefinition.md) - - [DatadogAPIClient::V1::QueryValueWidgetDefinitionType](QueryValueWidgetDefinitionType.md) - - [DatadogAPIClient::V1::QueryValueWidgetRequest](QueryValueWidgetRequest.md) - - [DatadogAPIClient::V1::ResponseMetaAttributes](ResponseMetaAttributes.md) - - [DatadogAPIClient::V1::SLOBulkDeleteError](SLOBulkDeleteError.md) - - [DatadogAPIClient::V1::SLOBulkDeleteResponse](SLOBulkDeleteResponse.md) - - [DatadogAPIClient::V1::SLOBulkDeleteResponseData](SLOBulkDeleteResponseData.md) - - [DatadogAPIClient::V1::SLOCorrection](SLOCorrection.md) - - [DatadogAPIClient::V1::SLOCorrectionCategory](SLOCorrectionCategory.md) - - [DatadogAPIClient::V1::SLOCorrectionCreateData](SLOCorrectionCreateData.md) - - [DatadogAPIClient::V1::SLOCorrectionCreateRequest](SLOCorrectionCreateRequest.md) - - [DatadogAPIClient::V1::SLOCorrectionCreateRequestAttributes](SLOCorrectionCreateRequestAttributes.md) - - [DatadogAPIClient::V1::SLOCorrectionListResponse](SLOCorrectionListResponse.md) - - [DatadogAPIClient::V1::SLOCorrectionResponse](SLOCorrectionResponse.md) - - [DatadogAPIClient::V1::SLOCorrectionResponseAttributes](SLOCorrectionResponseAttributes.md) - - [DatadogAPIClient::V1::SLOCorrectionType](SLOCorrectionType.md) - - [DatadogAPIClient::V1::SLOCorrectionUpdateData](SLOCorrectionUpdateData.md) - - [DatadogAPIClient::V1::SLOCorrectionUpdateRequest](SLOCorrectionUpdateRequest.md) - - [DatadogAPIClient::V1::SLOCorrectionUpdateRequestAttributes](SLOCorrectionUpdateRequestAttributes.md) - - [DatadogAPIClient::V1::SLODeleteResponse](SLODeleteResponse.md) - - [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) - - [DatadogAPIClient::V1::SLOResponseData](SLOResponseData.md) - - [DatadogAPIClient::V1::SLOThreshold](SLOThreshold.md) - - [DatadogAPIClient::V1::SLOTimeframe](SLOTimeframe.md) - - [DatadogAPIClient::V1::SLOType](SLOType.md) - - [DatadogAPIClient::V1::SLOTypeNumeric](SLOTypeNumeric.md) - - [DatadogAPIClient::V1::SLOWidgetDefinition](SLOWidgetDefinition.md) - - [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::ScatterplotDimension](ScatterplotDimension.md) - - [DatadogAPIClient::V1::ScatterplotTableRequest](ScatterplotTableRequest.md) - - [DatadogAPIClient::V1::ScatterplotWidgetAggregator](ScatterplotWidgetAggregator.md) - - [DatadogAPIClient::V1::ScatterplotWidgetFormula](ScatterplotWidgetFormula.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) - - [DatadogAPIClient::V1::ServiceLevelObjectiveRequest](ServiceLevelObjectiveRequest.md) - - [DatadogAPIClient::V1::ServiceMapWidgetDefinition](ServiceMapWidgetDefinition.md) - - [DatadogAPIClient::V1::ServiceMapWidgetDefinitionType](ServiceMapWidgetDefinitionType.md) - - [DatadogAPIClient::V1::ServiceSummaryWidgetDefinition](ServiceSummaryWidgetDefinition.md) - - [DatadogAPIClient::V1::ServiceSummaryWidgetDefinitionType](ServiceSummaryWidgetDefinitionType.md) - - [DatadogAPIClient::V1::SlackIntegrationChannel](SlackIntegrationChannel.md) - - [DatadogAPIClient::V1::SlackIntegrationChannelDisplay](SlackIntegrationChannelDisplay.md) - - [DatadogAPIClient::V1::SyntheticsAPIStep](SyntheticsAPIStep.md) - - [DatadogAPIClient::V1::SyntheticsAPIStepSubtype](SyntheticsAPIStepSubtype.md) - - [DatadogAPIClient::V1::SyntheticsAPITest](SyntheticsAPITest.md) - - [DatadogAPIClient::V1::SyntheticsAPITestConfig](SyntheticsAPITestConfig.md) - - [DatadogAPIClient::V1::SyntheticsAPITestResultData](SyntheticsAPITestResultData.md) - - [DatadogAPIClient::V1::SyntheticsAPITestResultFull](SyntheticsAPITestResultFull.md) - - [DatadogAPIClient::V1::SyntheticsAPITestResultFullCheck](SyntheticsAPITestResultFullCheck.md) - - [DatadogAPIClient::V1::SyntheticsAPITestResultShort](SyntheticsAPITestResultShort.md) - - [DatadogAPIClient::V1::SyntheticsAPITestResultShortResult](SyntheticsAPITestResultShortResult.md) - - [DatadogAPIClient::V1::SyntheticsAPITestType](SyntheticsAPITestType.md) - - [DatadogAPIClient::V1::SyntheticsAssertion](SyntheticsAssertion.md) - - [DatadogAPIClient::V1::SyntheticsAssertionJSONPathOperator](SyntheticsAssertionJSONPathOperator.md) - - [DatadogAPIClient::V1::SyntheticsAssertionJSONPathTarget](SyntheticsAssertionJSONPathTarget.md) - - [DatadogAPIClient::V1::SyntheticsAssertionJSONPathTargetTarget](SyntheticsAssertionJSONPathTargetTarget.md) - - [DatadogAPIClient::V1::SyntheticsAssertionOperator](SyntheticsAssertionOperator.md) - - [DatadogAPIClient::V1::SyntheticsAssertionTarget](SyntheticsAssertionTarget.md) - - [DatadogAPIClient::V1::SyntheticsAssertionType](SyntheticsAssertionType.md) - - [DatadogAPIClient::V1::SyntheticsBasicAuth](SyntheticsBasicAuth.md) - - [DatadogAPIClient::V1::SyntheticsBatchDetails](SyntheticsBatchDetails.md) - - [DatadogAPIClient::V1::SyntheticsBatchDetailsData](SyntheticsBatchDetailsData.md) - - [DatadogAPIClient::V1::SyntheticsBatchResult](SyntheticsBatchResult.md) - - [DatadogAPIClient::V1::SyntheticsBrowserError](SyntheticsBrowserError.md) - - [DatadogAPIClient::V1::SyntheticsBrowserErrorType](SyntheticsBrowserErrorType.md) - - [DatadogAPIClient::V1::SyntheticsBrowserTest](SyntheticsBrowserTest.md) - - [DatadogAPIClient::V1::SyntheticsBrowserTestConfig](SyntheticsBrowserTestConfig.md) - - [DatadogAPIClient::V1::SyntheticsBrowserTestResultData](SyntheticsBrowserTestResultData.md) - - [DatadogAPIClient::V1::SyntheticsBrowserTestResultFull](SyntheticsBrowserTestResultFull.md) - - [DatadogAPIClient::V1::SyntheticsBrowserTestResultFullCheck](SyntheticsBrowserTestResultFullCheck.md) - - [DatadogAPIClient::V1::SyntheticsBrowserTestResultShort](SyntheticsBrowserTestResultShort.md) - - [DatadogAPIClient::V1::SyntheticsBrowserTestResultShortResult](SyntheticsBrowserTestResultShortResult.md) - - [DatadogAPIClient::V1::SyntheticsBrowserTestType](SyntheticsBrowserTestType.md) - - [DatadogAPIClient::V1::SyntheticsBrowserVariable](SyntheticsBrowserVariable.md) - - [DatadogAPIClient::V1::SyntheticsBrowserVariableType](SyntheticsBrowserVariableType.md) - - [DatadogAPIClient::V1::SyntheticsCIBatchMetadata](SyntheticsCIBatchMetadata.md) - - [DatadogAPIClient::V1::SyntheticsCIBatchMetadataCI](SyntheticsCIBatchMetadataCI.md) - - [DatadogAPIClient::V1::SyntheticsCIBatchMetadataGit](SyntheticsCIBatchMetadataGit.md) - - [DatadogAPIClient::V1::SyntheticsCITest](SyntheticsCITest.md) - - [DatadogAPIClient::V1::SyntheticsCITestBody](SyntheticsCITestBody.md) - - [DatadogAPIClient::V1::SyntheticsCheckType](SyntheticsCheckType.md) - - [DatadogAPIClient::V1::SyntheticsConfigVariable](SyntheticsConfigVariable.md) - - [DatadogAPIClient::V1::SyntheticsConfigVariableType](SyntheticsConfigVariableType.md) - - [DatadogAPIClient::V1::SyntheticsCoreWebVitals](SyntheticsCoreWebVitals.md) - - [DatadogAPIClient::V1::SyntheticsDeleteTestsPayload](SyntheticsDeleteTestsPayload.md) - - [DatadogAPIClient::V1::SyntheticsDeleteTestsResponse](SyntheticsDeleteTestsResponse.md) - - [DatadogAPIClient::V1::SyntheticsDeletedTest](SyntheticsDeletedTest.md) - - [DatadogAPIClient::V1::SyntheticsDevice](SyntheticsDevice.md) - - [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) - - [DatadogAPIClient::V1::SyntheticsListTestsResponse](SyntheticsListTestsResponse.md) - - [DatadogAPIClient::V1::SyntheticsLocation](SyntheticsLocation.md) - - [DatadogAPIClient::V1::SyntheticsLocations](SyntheticsLocations.md) - - [DatadogAPIClient::V1::SyntheticsParsingOptions](SyntheticsParsingOptions.md) - - [DatadogAPIClient::V1::SyntheticsPlayingTab](SyntheticsPlayingTab.md) - - [DatadogAPIClient::V1::SyntheticsPrivateLocation](SyntheticsPrivateLocation.md) - - [DatadogAPIClient::V1::SyntheticsPrivateLocationCreationResponse](SyntheticsPrivateLocationCreationResponse.md) - - [DatadogAPIClient::V1::SyntheticsPrivateLocationCreationResponseResultEncryption](SyntheticsPrivateLocationCreationResponseResultEncryption.md) - - [DatadogAPIClient::V1::SyntheticsPrivateLocationSecrets](SyntheticsPrivateLocationSecrets.md) - - [DatadogAPIClient::V1::SyntheticsPrivateLocationSecretsAuthentication](SyntheticsPrivateLocationSecretsAuthentication.md) - - [DatadogAPIClient::V1::SyntheticsPrivateLocationSecretsConfigDecryption](SyntheticsPrivateLocationSecretsConfigDecryption.md) - - [DatadogAPIClient::V1::SyntheticsSSLCertificate](SyntheticsSSLCertificate.md) - - [DatadogAPIClient::V1::SyntheticsSSLCertificateIssuer](SyntheticsSSLCertificateIssuer.md) - - [DatadogAPIClient::V1::SyntheticsSSLCertificateSubject](SyntheticsSSLCertificateSubject.md) - - [DatadogAPIClient::V1::SyntheticsStatus](SyntheticsStatus.md) - - [DatadogAPIClient::V1::SyntheticsStep](SyntheticsStep.md) - - [DatadogAPIClient::V1::SyntheticsStepDetail](SyntheticsStepDetail.md) - - [DatadogAPIClient::V1::SyntheticsStepDetailWarning](SyntheticsStepDetailWarning.md) - - [DatadogAPIClient::V1::SyntheticsStepType](SyntheticsStepType.md) - - [DatadogAPIClient::V1::SyntheticsTestConfig](SyntheticsTestConfig.md) - - [DatadogAPIClient::V1::SyntheticsTestDetails](SyntheticsTestDetails.md) - - [DatadogAPIClient::V1::SyntheticsTestDetailsSubType](SyntheticsTestDetailsSubType.md) - - [DatadogAPIClient::V1::SyntheticsTestDetailsType](SyntheticsTestDetailsType.md) - - [DatadogAPIClient::V1::SyntheticsTestExecutionRule](SyntheticsTestExecutionRule.md) - - [DatadogAPIClient::V1::SyntheticsTestMonitorStatus](SyntheticsTestMonitorStatus.md) - - [DatadogAPIClient::V1::SyntheticsTestOptions](SyntheticsTestOptions.md) - - [DatadogAPIClient::V1::SyntheticsTestOptionsMonitorOptions](SyntheticsTestOptionsMonitorOptions.md) - - [DatadogAPIClient::V1::SyntheticsTestOptionsRetry](SyntheticsTestOptionsRetry.md) - - [DatadogAPIClient::V1::SyntheticsTestPauseStatus](SyntheticsTestPauseStatus.md) - - [DatadogAPIClient::V1::SyntheticsTestProcessStatus](SyntheticsTestProcessStatus.md) - - [DatadogAPIClient::V1::SyntheticsTestRequest](SyntheticsTestRequest.md) - - [DatadogAPIClient::V1::SyntheticsTestRequestCertificate](SyntheticsTestRequestCertificate.md) - - [DatadogAPIClient::V1::SyntheticsTestRequestCertificateItem](SyntheticsTestRequestCertificateItem.md) - - [DatadogAPIClient::V1::SyntheticsTiming](SyntheticsTiming.md) - - [DatadogAPIClient::V1::SyntheticsTriggerCITestLocation](SyntheticsTriggerCITestLocation.md) - - [DatadogAPIClient::V1::SyntheticsTriggerCITestRunResult](SyntheticsTriggerCITestRunResult.md) - - [DatadogAPIClient::V1::SyntheticsTriggerCITestsResponse](SyntheticsTriggerCITestsResponse.md) - - [DatadogAPIClient::V1::SyntheticsUpdateTestPauseStatusPayload](SyntheticsUpdateTestPauseStatusPayload.md) - - [DatadogAPIClient::V1::SyntheticsVariableParser](SyntheticsVariableParser.md) - - [DatadogAPIClient::V1::SyntheticsWarningType](SyntheticsWarningType.md) - - [DatadogAPIClient::V1::TableWidgetCellDisplayMode](TableWidgetCellDisplayMode.md) - - [DatadogAPIClient::V1::TableWidgetDefinition](TableWidgetDefinition.md) - - [DatadogAPIClient::V1::TableWidgetDefinitionType](TableWidgetDefinitionType.md) - - [DatadogAPIClient::V1::TableWidgetHasSearchBar](TableWidgetHasSearchBar.md) - - [DatadogAPIClient::V1::TableWidgetRequest](TableWidgetRequest.md) - - [DatadogAPIClient::V1::TagToHosts](TagToHosts.md) - - [DatadogAPIClient::V1::TargetFormatType](TargetFormatType.md) - - [DatadogAPIClient::V1::TimeseriesWidgetDefinition](TimeseriesWidgetDefinition.md) - - [DatadogAPIClient::V1::TimeseriesWidgetDefinitionType](TimeseriesWidgetDefinitionType.md) - - [DatadogAPIClient::V1::TimeseriesWidgetExpressionAlias](TimeseriesWidgetExpressionAlias.md) - - [DatadogAPIClient::V1::TimeseriesWidgetLegendColumn](TimeseriesWidgetLegendColumn.md) - - [DatadogAPIClient::V1::TimeseriesWidgetLegendLayout](TimeseriesWidgetLegendLayout.md) - - [DatadogAPIClient::V1::TimeseriesWidgetRequest](TimeseriesWidgetRequest.md) - - [DatadogAPIClient::V1::ToplistWidgetDefinition](ToplistWidgetDefinition.md) - - [DatadogAPIClient::V1::ToplistWidgetDefinitionType](ToplistWidgetDefinitionType.md) - - [DatadogAPIClient::V1::ToplistWidgetRequest](ToplistWidgetRequest.md) - - [DatadogAPIClient::V1::TreeMapColorBy](TreeMapColorBy.md) - - [DatadogAPIClient::V1::TreeMapGroupBy](TreeMapGroupBy.md) - - [DatadogAPIClient::V1::TreeMapSizeBy](TreeMapSizeBy.md) - - [DatadogAPIClient::V1::TreeMapWidgetDefinition](TreeMapWidgetDefinition.md) - - [DatadogAPIClient::V1::TreeMapWidgetDefinitionType](TreeMapWidgetDefinitionType.md) - - [DatadogAPIClient::V1::TreeMapWidgetRequest](TreeMapWidgetRequest.md) - - [DatadogAPIClient::V1::UsageAnalyzedLogsHour](UsageAnalyzedLogsHour.md) - - [DatadogAPIClient::V1::UsageAnalyzedLogsResponse](UsageAnalyzedLogsResponse.md) - - [DatadogAPIClient::V1::UsageAttributionAggregatesBody](UsageAttributionAggregatesBody.md) - - [DatadogAPIClient::V1::UsageAttributionBody](UsageAttributionBody.md) - - [DatadogAPIClient::V1::UsageAttributionMetadata](UsageAttributionMetadata.md) - - [DatadogAPIClient::V1::UsageAttributionPagination](UsageAttributionPagination.md) - - [DatadogAPIClient::V1::UsageAttributionResponse](UsageAttributionResponse.md) - - [DatadogAPIClient::V1::UsageAttributionSort](UsageAttributionSort.md) - - [DatadogAPIClient::V1::UsageAttributionSupportedMetrics](UsageAttributionSupportedMetrics.md) - - [DatadogAPIClient::V1::UsageAttributionValues](UsageAttributionValues.md) - - [DatadogAPIClient::V1::UsageAuditLogsHour](UsageAuditLogsHour.md) - - [DatadogAPIClient::V1::UsageAuditLogsResponse](UsageAuditLogsResponse.md) - - [DatadogAPIClient::V1::UsageBillableSummaryBody](UsageBillableSummaryBody.md) - - [DatadogAPIClient::V1::UsageBillableSummaryHour](UsageBillableSummaryHour.md) - - [DatadogAPIClient::V1::UsageBillableSummaryKeys](UsageBillableSummaryKeys.md) - - [DatadogAPIClient::V1::UsageBillableSummaryResponse](UsageBillableSummaryResponse.md) - - [DatadogAPIClient::V1::UsageCWSHour](UsageCWSHour.md) - - [DatadogAPIClient::V1::UsageCWSResponse](UsageCWSResponse.md) - - [DatadogAPIClient::V1::UsageCloudSecurityPostureManagementHour](UsageCloudSecurityPostureManagementHour.md) - - [DatadogAPIClient::V1::UsageCloudSecurityPostureManagementResponse](UsageCloudSecurityPostureManagementResponse.md) - - [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) - - [DatadogAPIClient::V1::UsageIncidentManagementResponse](UsageIncidentManagementResponse.md) - - [DatadogAPIClient::V1::UsageIndexedSpansHour](UsageIndexedSpansHour.md) - - [DatadogAPIClient::V1::UsageIndexedSpansResponse](UsageIndexedSpansResponse.md) - - [DatadogAPIClient::V1::UsageIngestedSpansHour](UsageIngestedSpansHour.md) - - [DatadogAPIClient::V1::UsageIngestedSpansResponse](UsageIngestedSpansResponse.md) - - [DatadogAPIClient::V1::UsageIoTHour](UsageIoTHour.md) - - [DatadogAPIClient::V1::UsageIoTResponse](UsageIoTResponse.md) - - [DatadogAPIClient::V1::UsageLambdaHour](UsageLambdaHour.md) - - [DatadogAPIClient::V1::UsageLambdaResponse](UsageLambdaResponse.md) - - [DatadogAPIClient::V1::UsageLogsByIndexHour](UsageLogsByIndexHour.md) - - [DatadogAPIClient::V1::UsageLogsByIndexResponse](UsageLogsByIndexResponse.md) - - [DatadogAPIClient::V1::UsageLogsByRetentionHour](UsageLogsByRetentionHour.md) - - [DatadogAPIClient::V1::UsageLogsByRetentionResponse](UsageLogsByRetentionResponse.md) - - [DatadogAPIClient::V1::UsageLogsHour](UsageLogsHour.md) - - [DatadogAPIClient::V1::UsageLogsResponse](UsageLogsResponse.md) - - [DatadogAPIClient::V1::UsageMetricCategory](UsageMetricCategory.md) - - [DatadogAPIClient::V1::UsageNetworkFlowsHour](UsageNetworkFlowsHour.md) - - [DatadogAPIClient::V1::UsageNetworkFlowsResponse](UsageNetworkFlowsResponse.md) - - [DatadogAPIClient::V1::UsageNetworkHostsHour](UsageNetworkHostsHour.md) - - [DatadogAPIClient::V1::UsageNetworkHostsResponse](UsageNetworkHostsResponse.md) - - [DatadogAPIClient::V1::UsageProfilingHour](UsageProfilingHour.md) - - [DatadogAPIClient::V1::UsageProfilingResponse](UsageProfilingResponse.md) - - [DatadogAPIClient::V1::UsageReportsType](UsageReportsType.md) - - [DatadogAPIClient::V1::UsageRumSessionsHour](UsageRumSessionsHour.md) - - [DatadogAPIClient::V1::UsageRumSessionsResponse](UsageRumSessionsResponse.md) - - [DatadogAPIClient::V1::UsageSDSHour](UsageSDSHour.md) - - [DatadogAPIClient::V1::UsageSDSResponse](UsageSDSResponse.md) - - [DatadogAPIClient::V1::UsageSNMPHour](UsageSNMPHour.md) - - [DatadogAPIClient::V1::UsageSNMPResponse](UsageSNMPResponse.md) - - [DatadogAPIClient::V1::UsageSort](UsageSort.md) - - [DatadogAPIClient::V1::UsageSortDirection](UsageSortDirection.md) - - [DatadogAPIClient::V1::UsageSpecifiedCustomReportsAttributes](UsageSpecifiedCustomReportsAttributes.md) - - [DatadogAPIClient::V1::UsageSpecifiedCustomReportsData](UsageSpecifiedCustomReportsData.md) - - [DatadogAPIClient::V1::UsageSpecifiedCustomReportsMeta](UsageSpecifiedCustomReportsMeta.md) - - [DatadogAPIClient::V1::UsageSpecifiedCustomReportsPage](UsageSpecifiedCustomReportsPage.md) - - [DatadogAPIClient::V1::UsageSpecifiedCustomReportsResponse](UsageSpecifiedCustomReportsResponse.md) - - [DatadogAPIClient::V1::UsageSummaryDate](UsageSummaryDate.md) - - [DatadogAPIClient::V1::UsageSummaryDateOrg](UsageSummaryDateOrg.md) - - [DatadogAPIClient::V1::UsageSummaryResponse](UsageSummaryResponse.md) - - [DatadogAPIClient::V1::UsageSyntheticsAPIHour](UsageSyntheticsAPIHour.md) - - [DatadogAPIClient::V1::UsageSyntheticsAPIResponse](UsageSyntheticsAPIResponse.md) - - [DatadogAPIClient::V1::UsageSyntheticsBrowserHour](UsageSyntheticsBrowserHour.md) - - [DatadogAPIClient::V1::UsageSyntheticsBrowserResponse](UsageSyntheticsBrowserResponse.md) - - [DatadogAPIClient::V1::UsageSyntheticsHour](UsageSyntheticsHour.md) - - [DatadogAPIClient::V1::UsageSyntheticsResponse](UsageSyntheticsResponse.md) - - [DatadogAPIClient::V1::UsageTimeseriesHour](UsageTimeseriesHour.md) - - [DatadogAPIClient::V1::UsageTimeseriesResponse](UsageTimeseriesResponse.md) - - [DatadogAPIClient::V1::UsageTopAvgMetricsHour](UsageTopAvgMetricsHour.md) - - [DatadogAPIClient::V1::UsageTopAvgMetricsMetadata](UsageTopAvgMetricsMetadata.md) - - [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) - - [DatadogAPIClient::V1::WidgetComparator](WidgetComparator.md) - - [DatadogAPIClient::V1::WidgetCompareTo](WidgetCompareTo.md) - - [DatadogAPIClient::V1::WidgetConditionalFormat](WidgetConditionalFormat.md) - - [DatadogAPIClient::V1::WidgetCustomLink](WidgetCustomLink.md) - - [DatadogAPIClient::V1::WidgetDefinition](WidgetDefinition.md) - - [DatadogAPIClient::V1::WidgetDisplayType](WidgetDisplayType.md) - - [DatadogAPIClient::V1::WidgetEvent](WidgetEvent.md) - - [DatadogAPIClient::V1::WidgetEventSize](WidgetEventSize.md) - - [DatadogAPIClient::V1::WidgetFieldSort](WidgetFieldSort.md) - - [DatadogAPIClient::V1::WidgetFormula](WidgetFormula.md) - - [DatadogAPIClient::V1::WidgetFormulaLimit](WidgetFormulaLimit.md) - - [DatadogAPIClient::V1::WidgetGrouping](WidgetGrouping.md) - - [DatadogAPIClient::V1::WidgetHorizontalAlign](WidgetHorizontalAlign.md) - - [DatadogAPIClient::V1::WidgetImageSizing](WidgetImageSizing.md) - - [DatadogAPIClient::V1::WidgetLayout](WidgetLayout.md) - - [DatadogAPIClient::V1::WidgetLayoutType](WidgetLayoutType.md) - - [DatadogAPIClient::V1::WidgetLineType](WidgetLineType.md) - - [DatadogAPIClient::V1::WidgetLineWidth](WidgetLineWidth.md) - - [DatadogAPIClient::V1::WidgetLiveSpan](WidgetLiveSpan.md) - - [DatadogAPIClient::V1::WidgetMargin](WidgetMargin.md) - - [DatadogAPIClient::V1::WidgetMarker](WidgetMarker.md) - - [DatadogAPIClient::V1::WidgetMessageDisplay](WidgetMessageDisplay.md) - - [DatadogAPIClient::V1::WidgetMonitorSummaryDisplayFormat](WidgetMonitorSummaryDisplayFormat.md) - - [DatadogAPIClient::V1::WidgetMonitorSummarySort](WidgetMonitorSummarySort.md) - - [DatadogAPIClient::V1::WidgetNodeType](WidgetNodeType.md) - - [DatadogAPIClient::V1::WidgetOrderBy](WidgetOrderBy.md) - - [DatadogAPIClient::V1::WidgetPalette](WidgetPalette.md) - - [DatadogAPIClient::V1::WidgetRequestStyle](WidgetRequestStyle.md) - - [DatadogAPIClient::V1::WidgetServiceSummaryDisplayFormat](WidgetServiceSummaryDisplayFormat.md) - - [DatadogAPIClient::V1::WidgetSizeFormat](WidgetSizeFormat.md) - - [DatadogAPIClient::V1::WidgetSort](WidgetSort.md) - - [DatadogAPIClient::V1::WidgetStyle](WidgetStyle.md) - - [DatadogAPIClient::V1::WidgetSummaryType](WidgetSummaryType.md) - - [DatadogAPIClient::V1::WidgetTextAlign](WidgetTextAlign.md) - - [DatadogAPIClient::V1::WidgetTickEdge](WidgetTickEdge.md) - - [DatadogAPIClient::V1::WidgetTime](WidgetTime.md) - - [DatadogAPIClient::V1::WidgetTimeWindows](WidgetTimeWindows.md) - - [DatadogAPIClient::V1::WidgetVerticalAlign](WidgetVerticalAlign.md) - - [DatadogAPIClient::V1::WidgetViewMode](WidgetViewMode.md) - - [DatadogAPIClient::V1::WidgetVizType](WidgetVizType.md) - +- [DatadogAPIClient::V1::APIErrorResponse](APIErrorResponse.md) +- [DatadogAPIClient::V1::AWSAccount](AWSAccount.md) +- [DatadogAPIClient::V1::AWSAccountAndLambdaRequest](AWSAccountAndLambdaRequest.md) +- [DatadogAPIClient::V1::AWSAccountCreateResponse](AWSAccountCreateResponse.md) +- [DatadogAPIClient::V1::AWSAccountDeleteRequest](AWSAccountDeleteRequest.md) +- [DatadogAPIClient::V1::AWSAccountListResponse](AWSAccountListResponse.md) +- [DatadogAPIClient::V1::AWSLogsAsyncError](AWSLogsAsyncError.md) +- [DatadogAPIClient::V1::AWSLogsAsyncResponse](AWSLogsAsyncResponse.md) +- [DatadogAPIClient::V1::AWSLogsLambda](AWSLogsLambda.md) +- [DatadogAPIClient::V1::AWSLogsListResponse](AWSLogsListResponse.md) +- [DatadogAPIClient::V1::AWSLogsListServicesResponse](AWSLogsListServicesResponse.md) +- [DatadogAPIClient::V1::AWSLogsServicesRequest](AWSLogsServicesRequest.md) +- [DatadogAPIClient::V1::AWSNamespace](AWSNamespace.md) +- [DatadogAPIClient::V1::AWSTagFilter](AWSTagFilter.md) +- [DatadogAPIClient::V1::AWSTagFilterCreateRequest](AWSTagFilterCreateRequest.md) +- [DatadogAPIClient::V1::AWSTagFilterDeleteRequest](AWSTagFilterDeleteRequest.md) +- [DatadogAPIClient::V1::AWSTagFilterListResponse](AWSTagFilterListResponse.md) +- [DatadogAPIClient::V1::AccessRole](AccessRole.md) +- [DatadogAPIClient::V1::AlertGraphWidgetDefinition](AlertGraphWidgetDefinition.md) +- [DatadogAPIClient::V1::AlertGraphWidgetDefinitionType](AlertGraphWidgetDefinitionType.md) +- [DatadogAPIClient::V1::AlertValueWidgetDefinition](AlertValueWidgetDefinition.md) +- [DatadogAPIClient::V1::AlertValueWidgetDefinitionType](AlertValueWidgetDefinitionType.md) +- [DatadogAPIClient::V1::ApiKey](ApiKey.md) +- [DatadogAPIClient::V1::ApiKeyListResponse](ApiKeyListResponse.md) +- [DatadogAPIClient::V1::ApiKeyResponse](ApiKeyResponse.md) +- [DatadogAPIClient::V1::ApmStatsQueryColumnType](ApmStatsQueryColumnType.md) +- [DatadogAPIClient::V1::ApmStatsQueryDefinition](ApmStatsQueryDefinition.md) +- [DatadogAPIClient::V1::ApmStatsQueryRowType](ApmStatsQueryRowType.md) +- [DatadogAPIClient::V1::ApplicationKey](ApplicationKey.md) +- [DatadogAPIClient::V1::ApplicationKeyListResponse](ApplicationKeyListResponse.md) +- [DatadogAPIClient::V1::ApplicationKeyResponse](ApplicationKeyResponse.md) +- [DatadogAPIClient::V1::AuthenticationValidationResponse](AuthenticationValidationResponse.md) +- [DatadogAPIClient::V1::AzureAccount](AzureAccount.md) +- [DatadogAPIClient::V1::CancelDowntimesByScopeRequest](CancelDowntimesByScopeRequest.md) +- [DatadogAPIClient::V1::CanceledDowntimesIds](CanceledDowntimesIds.md) +- [DatadogAPIClient::V1::ChangeWidgetDefinition](ChangeWidgetDefinition.md) +- [DatadogAPIClient::V1::ChangeWidgetDefinitionType](ChangeWidgetDefinitionType.md) +- [DatadogAPIClient::V1::ChangeWidgetRequest](ChangeWidgetRequest.md) +- [DatadogAPIClient::V1::CheckCanDeleteMonitorResponse](CheckCanDeleteMonitorResponse.md) +- [DatadogAPIClient::V1::CheckCanDeleteMonitorResponseData](CheckCanDeleteMonitorResponseData.md) +- [DatadogAPIClient::V1::CheckCanDeleteSLOResponse](CheckCanDeleteSLOResponse.md) +- [DatadogAPIClient::V1::CheckCanDeleteSLOResponseData](CheckCanDeleteSLOResponseData.md) +- [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) +- [DatadogAPIClient::V1::DeletedMonitor](DeletedMonitor.md) +- [DatadogAPIClient::V1::DistributionWidgetDefinition](DistributionWidgetDefinition.md) +- [DatadogAPIClient::V1::DistributionWidgetDefinitionType](DistributionWidgetDefinitionType.md) +- [DatadogAPIClient::V1::DistributionWidgetRequest](DistributionWidgetRequest.md) +- [DatadogAPIClient::V1::DistributionWidgetXAxis](DistributionWidgetXAxis.md) +- [DatadogAPIClient::V1::DistributionWidgetYAxis](DistributionWidgetYAxis.md) +- [DatadogAPIClient::V1::Downtime](Downtime.md) +- [DatadogAPIClient::V1::DowntimeChild](DowntimeChild.md) +- [DatadogAPIClient::V1::DowntimeRecurrence](DowntimeRecurrence.md) +- [DatadogAPIClient::V1::Event](Event.md) +- [DatadogAPIClient::V1::EventAlertType](EventAlertType.md) +- [DatadogAPIClient::V1::EventCreateRequest](EventCreateRequest.md) +- [DatadogAPIClient::V1::EventCreateResponse](EventCreateResponse.md) +- [DatadogAPIClient::V1::EventListResponse](EventListResponse.md) +- [DatadogAPIClient::V1::EventPriority](EventPriority.md) +- [DatadogAPIClient::V1::EventQueryDefinition](EventQueryDefinition.md) +- [DatadogAPIClient::V1::EventResponse](EventResponse.md) +- [DatadogAPIClient::V1::EventStreamWidgetDefinition](EventStreamWidgetDefinition.md) +- [DatadogAPIClient::V1::EventStreamWidgetDefinitionType](EventStreamWidgetDefinitionType.md) +- [DatadogAPIClient::V1::EventTimelineWidgetDefinition](EventTimelineWidgetDefinition.md) +- [DatadogAPIClient::V1::EventTimelineWidgetDefinitionType](EventTimelineWidgetDefinitionType.md) +- [DatadogAPIClient::V1::FormulaAndFunctionApmDependencyStatName](FormulaAndFunctionApmDependencyStatName.md) +- [DatadogAPIClient::V1::FormulaAndFunctionApmDependencyStatsDataSource](FormulaAndFunctionApmDependencyStatsDataSource.md) +- [DatadogAPIClient::V1::FormulaAndFunctionApmDependencyStatsQueryDefinition](FormulaAndFunctionApmDependencyStatsQueryDefinition.md) +- [DatadogAPIClient::V1::FormulaAndFunctionApmResourceStatName](FormulaAndFunctionApmResourceStatName.md) +- [DatadogAPIClient::V1::FormulaAndFunctionApmResourceStatsDataSource](FormulaAndFunctionApmResourceStatsDataSource.md) +- [DatadogAPIClient::V1::FormulaAndFunctionApmResourceStatsQueryDefinition](FormulaAndFunctionApmResourceStatsQueryDefinition.md) +- [DatadogAPIClient::V1::FormulaAndFunctionEventAggregation](FormulaAndFunctionEventAggregation.md) +- [DatadogAPIClient::V1::FormulaAndFunctionEventQueryDefinition](FormulaAndFunctionEventQueryDefinition.md) +- [DatadogAPIClient::V1::FormulaAndFunctionEventQueryDefinitionCompute](FormulaAndFunctionEventQueryDefinitionCompute.md) +- [DatadogAPIClient::V1::FormulaAndFunctionEventQueryDefinitionSearch](FormulaAndFunctionEventQueryDefinitionSearch.md) +- [DatadogAPIClient::V1::FormulaAndFunctionEventQueryGroupBy](FormulaAndFunctionEventQueryGroupBy.md) +- [DatadogAPIClient::V1::FormulaAndFunctionEventQueryGroupBySort](FormulaAndFunctionEventQueryGroupBySort.md) +- [DatadogAPIClient::V1::FormulaAndFunctionEventsDataSource](FormulaAndFunctionEventsDataSource.md) +- [DatadogAPIClient::V1::FormulaAndFunctionMetricAggregation](FormulaAndFunctionMetricAggregation.md) +- [DatadogAPIClient::V1::FormulaAndFunctionMetricDataSource](FormulaAndFunctionMetricDataSource.md) +- [DatadogAPIClient::V1::FormulaAndFunctionMetricQueryDefinition](FormulaAndFunctionMetricQueryDefinition.md) +- [DatadogAPIClient::V1::FormulaAndFunctionProcessQueryDataSource](FormulaAndFunctionProcessQueryDataSource.md) +- [DatadogAPIClient::V1::FormulaAndFunctionProcessQueryDefinition](FormulaAndFunctionProcessQueryDefinition.md) +- [DatadogAPIClient::V1::FormulaAndFunctionQueryDefinition](FormulaAndFunctionQueryDefinition.md) +- [DatadogAPIClient::V1::FormulaAndFunctionResponseFormat](FormulaAndFunctionResponseFormat.md) +- [DatadogAPIClient::V1::FreeTextWidgetDefinition](FreeTextWidgetDefinition.md) +- [DatadogAPIClient::V1::FreeTextWidgetDefinitionType](FreeTextWidgetDefinitionType.md) +- [DatadogAPIClient::V1::FunnelQuery](FunnelQuery.md) +- [DatadogAPIClient::V1::FunnelRequestType](FunnelRequestType.md) +- [DatadogAPIClient::V1::FunnelSource](FunnelSource.md) +- [DatadogAPIClient::V1::FunnelWidgetDefinition](FunnelWidgetDefinition.md) +- [DatadogAPIClient::V1::FunnelWidgetDefinitionType](FunnelWidgetDefinitionType.md) +- [DatadogAPIClient::V1::FunnelWidgetRequest](FunnelWidgetRequest.md) +- [DatadogAPIClient::V1::GCPAccount](GCPAccount.md) +- [DatadogAPIClient::V1::GeomapWidgetDefinition](GeomapWidgetDefinition.md) +- [DatadogAPIClient::V1::GeomapWidgetDefinitionStyle](GeomapWidgetDefinitionStyle.md) +- [DatadogAPIClient::V1::GeomapWidgetDefinitionType](GeomapWidgetDefinitionType.md) +- [DatadogAPIClient::V1::GeomapWidgetDefinitionView](GeomapWidgetDefinitionView.md) +- [DatadogAPIClient::V1::GeomapWidgetRequest](GeomapWidgetRequest.md) +- [DatadogAPIClient::V1::GraphSnapshot](GraphSnapshot.md) +- [DatadogAPIClient::V1::GroupWidgetDefinition](GroupWidgetDefinition.md) +- [DatadogAPIClient::V1::GroupWidgetDefinitionType](GroupWidgetDefinitionType.md) +- [DatadogAPIClient::V1::HTTPLogError](HTTPLogError.md) +- [DatadogAPIClient::V1::HTTPLogItem](HTTPLogItem.md) +- [DatadogAPIClient::V1::HTTPMethod](HTTPMethod.md) +- [DatadogAPIClient::V1::HeatMapWidgetDefinition](HeatMapWidgetDefinition.md) +- [DatadogAPIClient::V1::HeatMapWidgetDefinitionType](HeatMapWidgetDefinitionType.md) +- [DatadogAPIClient::V1::HeatMapWidgetRequest](HeatMapWidgetRequest.md) +- [DatadogAPIClient::V1::Host](Host.md) +- [DatadogAPIClient::V1::HostListResponse](HostListResponse.md) +- [DatadogAPIClient::V1::HostMapRequest](HostMapRequest.md) +- [DatadogAPIClient::V1::HostMapWidgetDefinition](HostMapWidgetDefinition.md) +- [DatadogAPIClient::V1::HostMapWidgetDefinitionRequests](HostMapWidgetDefinitionRequests.md) +- [DatadogAPIClient::V1::HostMapWidgetDefinitionStyle](HostMapWidgetDefinitionStyle.md) +- [DatadogAPIClient::V1::HostMapWidgetDefinitionType](HostMapWidgetDefinitionType.md) +- [DatadogAPIClient::V1::HostMeta](HostMeta.md) +- [DatadogAPIClient::V1::HostMetrics](HostMetrics.md) +- [DatadogAPIClient::V1::HostMuteResponse](HostMuteResponse.md) +- [DatadogAPIClient::V1::HostMuteSettings](HostMuteSettings.md) +- [DatadogAPIClient::V1::HostTags](HostTags.md) +- [DatadogAPIClient::V1::HostTotals](HostTotals.md) +- [DatadogAPIClient::V1::IFrameWidgetDefinition](IFrameWidgetDefinition.md) +- [DatadogAPIClient::V1::IFrameWidgetDefinitionType](IFrameWidgetDefinitionType.md) +- [DatadogAPIClient::V1::IPPrefixesAPI](IPPrefixesAPI.md) +- [DatadogAPIClient::V1::IPPrefixesAPM](IPPrefixesAPM.md) +- [DatadogAPIClient::V1::IPPrefixesAgents](IPPrefixesAgents.md) +- [DatadogAPIClient::V1::IPPrefixesLogs](IPPrefixesLogs.md) +- [DatadogAPIClient::V1::IPPrefixesProcess](IPPrefixesProcess.md) +- [DatadogAPIClient::V1::IPPrefixesSynthetics](IPPrefixesSynthetics.md) +- [DatadogAPIClient::V1::IPPrefixesWebhooks](IPPrefixesWebhooks.md) +- [DatadogAPIClient::V1::IPRanges](IPRanges.md) +- [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) +- [DatadogAPIClient::V1::LogQueryDefinitionSearch](LogQueryDefinitionSearch.md) +- [DatadogAPIClient::V1::LogStreamWidgetDefinition](LogStreamWidgetDefinition.md) +- [DatadogAPIClient::V1::LogStreamWidgetDefinitionType](LogStreamWidgetDefinitionType.md) +- [DatadogAPIClient::V1::LogsAPIError](LogsAPIError.md) +- [DatadogAPIClient::V1::LogsAPIErrorResponse](LogsAPIErrorResponse.md) +- [DatadogAPIClient::V1::LogsArithmeticProcessor](LogsArithmeticProcessor.md) +- [DatadogAPIClient::V1::LogsArithmeticProcessorType](LogsArithmeticProcessorType.md) +- [DatadogAPIClient::V1::LogsAttributeRemapper](LogsAttributeRemapper.md) +- [DatadogAPIClient::V1::LogsAttributeRemapperType](LogsAttributeRemapperType.md) +- [DatadogAPIClient::V1::LogsByRetention](LogsByRetention.md) +- [DatadogAPIClient::V1::LogsByRetentionMonthlyUsage](LogsByRetentionMonthlyUsage.md) +- [DatadogAPIClient::V1::LogsByRetentionOrgUsage](LogsByRetentionOrgUsage.md) +- [DatadogAPIClient::V1::LogsByRetentionOrgs](LogsByRetentionOrgs.md) +- [DatadogAPIClient::V1::LogsCategoryProcessor](LogsCategoryProcessor.md) +- [DatadogAPIClient::V1::LogsCategoryProcessorCategory](LogsCategoryProcessorCategory.md) +- [DatadogAPIClient::V1::LogsCategoryProcessorType](LogsCategoryProcessorType.md) +- [DatadogAPIClient::V1::LogsDateRemapper](LogsDateRemapper.md) +- [DatadogAPIClient::V1::LogsDateRemapperType](LogsDateRemapperType.md) +- [DatadogAPIClient::V1::LogsExclusion](LogsExclusion.md) +- [DatadogAPIClient::V1::LogsExclusionFilter](LogsExclusionFilter.md) +- [DatadogAPIClient::V1::LogsFilter](LogsFilter.md) +- [DatadogAPIClient::V1::LogsGeoIPParser](LogsGeoIPParser.md) +- [DatadogAPIClient::V1::LogsGeoIPParserType](LogsGeoIPParserType.md) +- [DatadogAPIClient::V1::LogsGrokParser](LogsGrokParser.md) +- [DatadogAPIClient::V1::LogsGrokParserRules](LogsGrokParserRules.md) +- [DatadogAPIClient::V1::LogsGrokParserType](LogsGrokParserType.md) +- [DatadogAPIClient::V1::LogsIndex](LogsIndex.md) +- [DatadogAPIClient::V1::LogsIndexListResponse](LogsIndexListResponse.md) +- [DatadogAPIClient::V1::LogsIndexUpdateRequest](LogsIndexUpdateRequest.md) +- [DatadogAPIClient::V1::LogsIndexesOrder](LogsIndexesOrder.md) +- [DatadogAPIClient::V1::LogsListRequest](LogsListRequest.md) +- [DatadogAPIClient::V1::LogsListRequestTime](LogsListRequestTime.md) +- [DatadogAPIClient::V1::LogsListResponse](LogsListResponse.md) +- [DatadogAPIClient::V1::LogsLookupProcessor](LogsLookupProcessor.md) +- [DatadogAPIClient::V1::LogsLookupProcessorType](LogsLookupProcessorType.md) +- [DatadogAPIClient::V1::LogsMessageRemapper](LogsMessageRemapper.md) +- [DatadogAPIClient::V1::LogsMessageRemapperType](LogsMessageRemapperType.md) +- [DatadogAPIClient::V1::LogsPipeline](LogsPipeline.md) +- [DatadogAPIClient::V1::LogsPipelineProcessor](LogsPipelineProcessor.md) +- [DatadogAPIClient::V1::LogsPipelineProcessorType](LogsPipelineProcessorType.md) +- [DatadogAPIClient::V1::LogsPipelinesOrder](LogsPipelinesOrder.md) +- [DatadogAPIClient::V1::LogsProcessor](LogsProcessor.md) +- [DatadogAPIClient::V1::LogsQueryCompute](LogsQueryCompute.md) +- [DatadogAPIClient::V1::LogsRetentionAggSumUsage](LogsRetentionAggSumUsage.md) +- [DatadogAPIClient::V1::LogsRetentionSumUsage](LogsRetentionSumUsage.md) +- [DatadogAPIClient::V1::LogsServiceRemapper](LogsServiceRemapper.md) +- [DatadogAPIClient::V1::LogsServiceRemapperType](LogsServiceRemapperType.md) +- [DatadogAPIClient::V1::LogsSort](LogsSort.md) +- [DatadogAPIClient::V1::LogsStatusRemapper](LogsStatusRemapper.md) +- [DatadogAPIClient::V1::LogsStatusRemapperType](LogsStatusRemapperType.md) +- [DatadogAPIClient::V1::LogsStringBuilderProcessor](LogsStringBuilderProcessor.md) +- [DatadogAPIClient::V1::LogsStringBuilderProcessorType](LogsStringBuilderProcessorType.md) +- [DatadogAPIClient::V1::LogsTraceRemapper](LogsTraceRemapper.md) +- [DatadogAPIClient::V1::LogsTraceRemapperType](LogsTraceRemapperType.md) +- [DatadogAPIClient::V1::LogsURLParser](LogsURLParser.md) +- [DatadogAPIClient::V1::LogsURLParserType](LogsURLParserType.md) +- [DatadogAPIClient::V1::LogsUserAgentParser](LogsUserAgentParser.md) +- [DatadogAPIClient::V1::LogsUserAgentParserType](LogsUserAgentParserType.md) +- [DatadogAPIClient::V1::MetricContentEncoding](MetricContentEncoding.md) +- [DatadogAPIClient::V1::MetricMetadata](MetricMetadata.md) +- [DatadogAPIClient::V1::MetricSearchResponse](MetricSearchResponse.md) +- [DatadogAPIClient::V1::MetricSearchResponseResults](MetricSearchResponseResults.md) +- [DatadogAPIClient::V1::MetricsListResponse](MetricsListResponse.md) +- [DatadogAPIClient::V1::MetricsPayload](MetricsPayload.md) +- [DatadogAPIClient::V1::MetricsQueryMetadata](MetricsQueryMetadata.md) +- [DatadogAPIClient::V1::MetricsQueryResponse](MetricsQueryResponse.md) +- [DatadogAPIClient::V1::MetricsQueryUnit](MetricsQueryUnit.md) +- [DatadogAPIClient::V1::Monitor](Monitor.md) +- [DatadogAPIClient::V1::MonitorDeviceID](MonitorDeviceID.md) +- [DatadogAPIClient::V1::MonitorGroupSearchResponse](MonitorGroupSearchResponse.md) +- [DatadogAPIClient::V1::MonitorGroupSearchResponseCounts](MonitorGroupSearchResponseCounts.md) +- [DatadogAPIClient::V1::MonitorGroupSearchResult](MonitorGroupSearchResult.md) +- [DatadogAPIClient::V1::MonitorOptions](MonitorOptions.md) +- [DatadogAPIClient::V1::MonitorOptionsAggregation](MonitorOptionsAggregation.md) +- [DatadogAPIClient::V1::MonitorOverallStates](MonitorOverallStates.md) +- [DatadogAPIClient::V1::MonitorRenotifyStatusType](MonitorRenotifyStatusType.md) +- [DatadogAPIClient::V1::MonitorSearchResponse](MonitorSearchResponse.md) +- [DatadogAPIClient::V1::MonitorSearchResponseCounts](MonitorSearchResponseCounts.md) +- [DatadogAPIClient::V1::MonitorSearchResponseMetadata](MonitorSearchResponseMetadata.md) +- [DatadogAPIClient::V1::MonitorSearchResult](MonitorSearchResult.md) +- [DatadogAPIClient::V1::MonitorSearchResultNotification](MonitorSearchResultNotification.md) +- [DatadogAPIClient::V1::MonitorState](MonitorState.md) +- [DatadogAPIClient::V1::MonitorStateGroup](MonitorStateGroup.md) +- [DatadogAPIClient::V1::MonitorSummaryWidgetDefinition](MonitorSummaryWidgetDefinition.md) +- [DatadogAPIClient::V1::MonitorSummaryWidgetDefinitionType](MonitorSummaryWidgetDefinitionType.md) +- [DatadogAPIClient::V1::MonitorThresholdWindowOptions](MonitorThresholdWindowOptions.md) +- [DatadogAPIClient::V1::MonitorThresholds](MonitorThresholds.md) +- [DatadogAPIClient::V1::MonitorType](MonitorType.md) +- [DatadogAPIClient::V1::MonitorUpdateRequest](MonitorUpdateRequest.md) +- [DatadogAPIClient::V1::NoteWidgetDefinition](NoteWidgetDefinition.md) +- [DatadogAPIClient::V1::NoteWidgetDefinitionType](NoteWidgetDefinitionType.md) +- [DatadogAPIClient::V1::NotebookAbsoluteTime](NotebookAbsoluteTime.md) +- [DatadogAPIClient::V1::NotebookAuthor](NotebookAuthor.md) +- [DatadogAPIClient::V1::NotebookCellCreateRequest](NotebookCellCreateRequest.md) +- [DatadogAPIClient::V1::NotebookCellCreateRequestAttributes](NotebookCellCreateRequestAttributes.md) +- [DatadogAPIClient::V1::NotebookCellResourceType](NotebookCellResourceType.md) +- [DatadogAPIClient::V1::NotebookCellResponse](NotebookCellResponse.md) +- [DatadogAPIClient::V1::NotebookCellResponseAttributes](NotebookCellResponseAttributes.md) +- [DatadogAPIClient::V1::NotebookCellTime](NotebookCellTime.md) +- [DatadogAPIClient::V1::NotebookCellUpdateRequest](NotebookCellUpdateRequest.md) +- [DatadogAPIClient::V1::NotebookCellUpdateRequestAttributes](NotebookCellUpdateRequestAttributes.md) +- [DatadogAPIClient::V1::NotebookCreateData](NotebookCreateData.md) +- [DatadogAPIClient::V1::NotebookCreateDataAttributes](NotebookCreateDataAttributes.md) +- [DatadogAPIClient::V1::NotebookCreateRequest](NotebookCreateRequest.md) +- [DatadogAPIClient::V1::NotebookDistributionCellAttributes](NotebookDistributionCellAttributes.md) +- [DatadogAPIClient::V1::NotebookGlobalTime](NotebookGlobalTime.md) +- [DatadogAPIClient::V1::NotebookGraphSize](NotebookGraphSize.md) +- [DatadogAPIClient::V1::NotebookHeatMapCellAttributes](NotebookHeatMapCellAttributes.md) +- [DatadogAPIClient::V1::NotebookLogStreamCellAttributes](NotebookLogStreamCellAttributes.md) +- [DatadogAPIClient::V1::NotebookMarkdownCellAttributes](NotebookMarkdownCellAttributes.md) +- [DatadogAPIClient::V1::NotebookMarkdownCellDefinition](NotebookMarkdownCellDefinition.md) +- [DatadogAPIClient::V1::NotebookMarkdownCellDefinitionType](NotebookMarkdownCellDefinitionType.md) +- [DatadogAPIClient::V1::NotebookMetadata](NotebookMetadata.md) +- [DatadogAPIClient::V1::NotebookMetadataType](NotebookMetadataType.md) +- [DatadogAPIClient::V1::NotebookRelativeTime](NotebookRelativeTime.md) +- [DatadogAPIClient::V1::NotebookResourceType](NotebookResourceType.md) +- [DatadogAPIClient::V1::NotebookResponse](NotebookResponse.md) +- [DatadogAPIClient::V1::NotebookResponseData](NotebookResponseData.md) +- [DatadogAPIClient::V1::NotebookResponseDataAttributes](NotebookResponseDataAttributes.md) +- [DatadogAPIClient::V1::NotebookSplitBy](NotebookSplitBy.md) +- [DatadogAPIClient::V1::NotebookStatus](NotebookStatus.md) +- [DatadogAPIClient::V1::NotebookTimeseriesCellAttributes](NotebookTimeseriesCellAttributes.md) +- [DatadogAPIClient::V1::NotebookToplistCellAttributes](NotebookToplistCellAttributes.md) +- [DatadogAPIClient::V1::NotebookUpdateCell](NotebookUpdateCell.md) +- [DatadogAPIClient::V1::NotebookUpdateData](NotebookUpdateData.md) +- [DatadogAPIClient::V1::NotebookUpdateDataAttributes](NotebookUpdateDataAttributes.md) +- [DatadogAPIClient::V1::NotebookUpdateRequest](NotebookUpdateRequest.md) +- [DatadogAPIClient::V1::NotebooksResponse](NotebooksResponse.md) +- [DatadogAPIClient::V1::NotebooksResponseData](NotebooksResponseData.md) +- [DatadogAPIClient::V1::NotebooksResponseDataAttributes](NotebooksResponseDataAttributes.md) +- [DatadogAPIClient::V1::NotebooksResponseMeta](NotebooksResponseMeta.md) +- [DatadogAPIClient::V1::NotebooksResponsePage](NotebooksResponsePage.md) +- [DatadogAPIClient::V1::Organization](Organization.md) +- [DatadogAPIClient::V1::OrganizationBilling](OrganizationBilling.md) +- [DatadogAPIClient::V1::OrganizationCreateBody](OrganizationCreateBody.md) +- [DatadogAPIClient::V1::OrganizationCreateResponse](OrganizationCreateResponse.md) +- [DatadogAPIClient::V1::OrganizationListResponse](OrganizationListResponse.md) +- [DatadogAPIClient::V1::OrganizationResponse](OrganizationResponse.md) +- [DatadogAPIClient::V1::OrganizationSettings](OrganizationSettings.md) +- [DatadogAPIClient::V1::OrganizationSettingsSaml](OrganizationSettingsSaml.md) +- [DatadogAPIClient::V1::OrganizationSettingsSamlAutocreateUsersDomains](OrganizationSettingsSamlAutocreateUsersDomains.md) +- [DatadogAPIClient::V1::OrganizationSettingsSamlIdpInitiatedLogin](OrganizationSettingsSamlIdpInitiatedLogin.md) +- [DatadogAPIClient::V1::OrganizationSettingsSamlStrictMode](OrganizationSettingsSamlStrictMode.md) +- [DatadogAPIClient::V1::OrganizationSubscription](OrganizationSubscription.md) +- [DatadogAPIClient::V1::PagerDutyService](PagerDutyService.md) +- [DatadogAPIClient::V1::PagerDutyServiceKey](PagerDutyServiceKey.md) +- [DatadogAPIClient::V1::PagerDutyServiceName](PagerDutyServiceName.md) +- [DatadogAPIClient::V1::Pagination](Pagination.md) +- [DatadogAPIClient::V1::ProcessQueryDefinition](ProcessQueryDefinition.md) +- [DatadogAPIClient::V1::QuerySortOrder](QuerySortOrder.md) +- [DatadogAPIClient::V1::QueryValueWidgetDefinition](QueryValueWidgetDefinition.md) +- [DatadogAPIClient::V1::QueryValueWidgetDefinitionType](QueryValueWidgetDefinitionType.md) +- [DatadogAPIClient::V1::QueryValueWidgetRequest](QueryValueWidgetRequest.md) +- [DatadogAPIClient::V1::ResponseMetaAttributes](ResponseMetaAttributes.md) +- [DatadogAPIClient::V1::SLOBulkDeleteError](SLOBulkDeleteError.md) +- [DatadogAPIClient::V1::SLOBulkDeleteResponse](SLOBulkDeleteResponse.md) +- [DatadogAPIClient::V1::SLOBulkDeleteResponseData](SLOBulkDeleteResponseData.md) +- [DatadogAPIClient::V1::SLOCorrection](SLOCorrection.md) +- [DatadogAPIClient::V1::SLOCorrectionCategory](SLOCorrectionCategory.md) +- [DatadogAPIClient::V1::SLOCorrectionCreateData](SLOCorrectionCreateData.md) +- [DatadogAPIClient::V1::SLOCorrectionCreateRequest](SLOCorrectionCreateRequest.md) +- [DatadogAPIClient::V1::SLOCorrectionCreateRequestAttributes](SLOCorrectionCreateRequestAttributes.md) +- [DatadogAPIClient::V1::SLOCorrectionListResponse](SLOCorrectionListResponse.md) +- [DatadogAPIClient::V1::SLOCorrectionResponse](SLOCorrectionResponse.md) +- [DatadogAPIClient::V1::SLOCorrectionResponseAttributes](SLOCorrectionResponseAttributes.md) +- [DatadogAPIClient::V1::SLOCorrectionType](SLOCorrectionType.md) +- [DatadogAPIClient::V1::SLOCorrectionUpdateData](SLOCorrectionUpdateData.md) +- [DatadogAPIClient::V1::SLOCorrectionUpdateRequest](SLOCorrectionUpdateRequest.md) +- [DatadogAPIClient::V1::SLOCorrectionUpdateRequestAttributes](SLOCorrectionUpdateRequestAttributes.md) +- [DatadogAPIClient::V1::SLODeleteResponse](SLODeleteResponse.md) +- [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) +- [DatadogAPIClient::V1::SLOResponseData](SLOResponseData.md) +- [DatadogAPIClient::V1::SLOThreshold](SLOThreshold.md) +- [DatadogAPIClient::V1::SLOTimeframe](SLOTimeframe.md) +- [DatadogAPIClient::V1::SLOType](SLOType.md) +- [DatadogAPIClient::V1::SLOTypeNumeric](SLOTypeNumeric.md) +- [DatadogAPIClient::V1::SLOWidgetDefinition](SLOWidgetDefinition.md) +- [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::ScatterplotDimension](ScatterplotDimension.md) +- [DatadogAPIClient::V1::ScatterplotTableRequest](ScatterplotTableRequest.md) +- [DatadogAPIClient::V1::ScatterplotWidgetAggregator](ScatterplotWidgetAggregator.md) +- [DatadogAPIClient::V1::ScatterplotWidgetFormula](ScatterplotWidgetFormula.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) +- [DatadogAPIClient::V1::ServiceLevelObjectiveRequest](ServiceLevelObjectiveRequest.md) +- [DatadogAPIClient::V1::ServiceMapWidgetDefinition](ServiceMapWidgetDefinition.md) +- [DatadogAPIClient::V1::ServiceMapWidgetDefinitionType](ServiceMapWidgetDefinitionType.md) +- [DatadogAPIClient::V1::ServiceSummaryWidgetDefinition](ServiceSummaryWidgetDefinition.md) +- [DatadogAPIClient::V1::ServiceSummaryWidgetDefinitionType](ServiceSummaryWidgetDefinitionType.md) +- [DatadogAPIClient::V1::SlackIntegrationChannel](SlackIntegrationChannel.md) +- [DatadogAPIClient::V1::SlackIntegrationChannelDisplay](SlackIntegrationChannelDisplay.md) +- [DatadogAPIClient::V1::SyntheticsAPIStep](SyntheticsAPIStep.md) +- [DatadogAPIClient::V1::SyntheticsAPIStepSubtype](SyntheticsAPIStepSubtype.md) +- [DatadogAPIClient::V1::SyntheticsAPITest](SyntheticsAPITest.md) +- [DatadogAPIClient::V1::SyntheticsAPITestConfig](SyntheticsAPITestConfig.md) +- [DatadogAPIClient::V1::SyntheticsAPITestResultData](SyntheticsAPITestResultData.md) +- [DatadogAPIClient::V1::SyntheticsAPITestResultFull](SyntheticsAPITestResultFull.md) +- [DatadogAPIClient::V1::SyntheticsAPITestResultFullCheck](SyntheticsAPITestResultFullCheck.md) +- [DatadogAPIClient::V1::SyntheticsAPITestResultShort](SyntheticsAPITestResultShort.md) +- [DatadogAPIClient::V1::SyntheticsAPITestResultShortResult](SyntheticsAPITestResultShortResult.md) +- [DatadogAPIClient::V1::SyntheticsAPITestType](SyntheticsAPITestType.md) +- [DatadogAPIClient::V1::SyntheticsAssertion](SyntheticsAssertion.md) +- [DatadogAPIClient::V1::SyntheticsAssertionJSONPathOperator](SyntheticsAssertionJSONPathOperator.md) +- [DatadogAPIClient::V1::SyntheticsAssertionJSONPathTarget](SyntheticsAssertionJSONPathTarget.md) +- [DatadogAPIClient::V1::SyntheticsAssertionJSONPathTargetTarget](SyntheticsAssertionJSONPathTargetTarget.md) +- [DatadogAPIClient::V1::SyntheticsAssertionOperator](SyntheticsAssertionOperator.md) +- [DatadogAPIClient::V1::SyntheticsAssertionTarget](SyntheticsAssertionTarget.md) +- [DatadogAPIClient::V1::SyntheticsAssertionType](SyntheticsAssertionType.md) +- [DatadogAPIClient::V1::SyntheticsBasicAuth](SyntheticsBasicAuth.md) +- [DatadogAPIClient::V1::SyntheticsBatchDetails](SyntheticsBatchDetails.md) +- [DatadogAPIClient::V1::SyntheticsBatchDetailsData](SyntheticsBatchDetailsData.md) +- [DatadogAPIClient::V1::SyntheticsBatchResult](SyntheticsBatchResult.md) +- [DatadogAPIClient::V1::SyntheticsBrowserError](SyntheticsBrowserError.md) +- [DatadogAPIClient::V1::SyntheticsBrowserErrorType](SyntheticsBrowserErrorType.md) +- [DatadogAPIClient::V1::SyntheticsBrowserTest](SyntheticsBrowserTest.md) +- [DatadogAPIClient::V1::SyntheticsBrowserTestConfig](SyntheticsBrowserTestConfig.md) +- [DatadogAPIClient::V1::SyntheticsBrowserTestResultData](SyntheticsBrowserTestResultData.md) +- [DatadogAPIClient::V1::SyntheticsBrowserTestResultFull](SyntheticsBrowserTestResultFull.md) +- [DatadogAPIClient::V1::SyntheticsBrowserTestResultFullCheck](SyntheticsBrowserTestResultFullCheck.md) +- [DatadogAPIClient::V1::SyntheticsBrowserTestResultShort](SyntheticsBrowserTestResultShort.md) +- [DatadogAPIClient::V1::SyntheticsBrowserTestResultShortResult](SyntheticsBrowserTestResultShortResult.md) +- [DatadogAPIClient::V1::SyntheticsBrowserTestType](SyntheticsBrowserTestType.md) +- [DatadogAPIClient::V1::SyntheticsBrowserVariable](SyntheticsBrowserVariable.md) +- [DatadogAPIClient::V1::SyntheticsBrowserVariableType](SyntheticsBrowserVariableType.md) +- [DatadogAPIClient::V1::SyntheticsCIBatchMetadata](SyntheticsCIBatchMetadata.md) +- [DatadogAPIClient::V1::SyntheticsCIBatchMetadataCI](SyntheticsCIBatchMetadataCI.md) +- [DatadogAPIClient::V1::SyntheticsCIBatchMetadataGit](SyntheticsCIBatchMetadataGit.md) +- [DatadogAPIClient::V1::SyntheticsCITest](SyntheticsCITest.md) +- [DatadogAPIClient::V1::SyntheticsCITestBody](SyntheticsCITestBody.md) +- [DatadogAPIClient::V1::SyntheticsCheckType](SyntheticsCheckType.md) +- [DatadogAPIClient::V1::SyntheticsConfigVariable](SyntheticsConfigVariable.md) +- [DatadogAPIClient::V1::SyntheticsConfigVariableType](SyntheticsConfigVariableType.md) +- [DatadogAPIClient::V1::SyntheticsCoreWebVitals](SyntheticsCoreWebVitals.md) +- [DatadogAPIClient::V1::SyntheticsDeleteTestsPayload](SyntheticsDeleteTestsPayload.md) +- [DatadogAPIClient::V1::SyntheticsDeleteTestsResponse](SyntheticsDeleteTestsResponse.md) +- [DatadogAPIClient::V1::SyntheticsDeletedTest](SyntheticsDeletedTest.md) +- [DatadogAPIClient::V1::SyntheticsDevice](SyntheticsDevice.md) +- [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) +- [DatadogAPIClient::V1::SyntheticsListTestsResponse](SyntheticsListTestsResponse.md) +- [DatadogAPIClient::V1::SyntheticsLocation](SyntheticsLocation.md) +- [DatadogAPIClient::V1::SyntheticsLocations](SyntheticsLocations.md) +- [DatadogAPIClient::V1::SyntheticsParsingOptions](SyntheticsParsingOptions.md) +- [DatadogAPIClient::V1::SyntheticsPlayingTab](SyntheticsPlayingTab.md) +- [DatadogAPIClient::V1::SyntheticsPrivateLocation](SyntheticsPrivateLocation.md) +- [DatadogAPIClient::V1::SyntheticsPrivateLocationCreationResponse](SyntheticsPrivateLocationCreationResponse.md) +- [DatadogAPIClient::V1::SyntheticsPrivateLocationCreationResponseResultEncryption](SyntheticsPrivateLocationCreationResponseResultEncryption.md) +- [DatadogAPIClient::V1::SyntheticsPrivateLocationSecrets](SyntheticsPrivateLocationSecrets.md) +- [DatadogAPIClient::V1::SyntheticsPrivateLocationSecretsAuthentication](SyntheticsPrivateLocationSecretsAuthentication.md) +- [DatadogAPIClient::V1::SyntheticsPrivateLocationSecretsConfigDecryption](SyntheticsPrivateLocationSecretsConfigDecryption.md) +- [DatadogAPIClient::V1::SyntheticsSSLCertificate](SyntheticsSSLCertificate.md) +- [DatadogAPIClient::V1::SyntheticsSSLCertificateIssuer](SyntheticsSSLCertificateIssuer.md) +- [DatadogAPIClient::V1::SyntheticsSSLCertificateSubject](SyntheticsSSLCertificateSubject.md) +- [DatadogAPIClient::V1::SyntheticsStatus](SyntheticsStatus.md) +- [DatadogAPIClient::V1::SyntheticsStep](SyntheticsStep.md) +- [DatadogAPIClient::V1::SyntheticsStepDetail](SyntheticsStepDetail.md) +- [DatadogAPIClient::V1::SyntheticsStepDetailWarning](SyntheticsStepDetailWarning.md) +- [DatadogAPIClient::V1::SyntheticsStepType](SyntheticsStepType.md) +- [DatadogAPIClient::V1::SyntheticsTestConfig](SyntheticsTestConfig.md) +- [DatadogAPIClient::V1::SyntheticsTestDetails](SyntheticsTestDetails.md) +- [DatadogAPIClient::V1::SyntheticsTestDetailsSubType](SyntheticsTestDetailsSubType.md) +- [DatadogAPIClient::V1::SyntheticsTestDetailsType](SyntheticsTestDetailsType.md) +- [DatadogAPIClient::V1::SyntheticsTestExecutionRule](SyntheticsTestExecutionRule.md) +- [DatadogAPIClient::V1::SyntheticsTestMonitorStatus](SyntheticsTestMonitorStatus.md) +- [DatadogAPIClient::V1::SyntheticsTestOptions](SyntheticsTestOptions.md) +- [DatadogAPIClient::V1::SyntheticsTestOptionsMonitorOptions](SyntheticsTestOptionsMonitorOptions.md) +- [DatadogAPIClient::V1::SyntheticsTestOptionsRetry](SyntheticsTestOptionsRetry.md) +- [DatadogAPIClient::V1::SyntheticsTestPauseStatus](SyntheticsTestPauseStatus.md) +- [DatadogAPIClient::V1::SyntheticsTestProcessStatus](SyntheticsTestProcessStatus.md) +- [DatadogAPIClient::V1::SyntheticsTestRequest](SyntheticsTestRequest.md) +- [DatadogAPIClient::V1::SyntheticsTestRequestCertificate](SyntheticsTestRequestCertificate.md) +- [DatadogAPIClient::V1::SyntheticsTestRequestCertificateItem](SyntheticsTestRequestCertificateItem.md) +- [DatadogAPIClient::V1::SyntheticsTiming](SyntheticsTiming.md) +- [DatadogAPIClient::V1::SyntheticsTriggerCITestLocation](SyntheticsTriggerCITestLocation.md) +- [DatadogAPIClient::V1::SyntheticsTriggerCITestRunResult](SyntheticsTriggerCITestRunResult.md) +- [DatadogAPIClient::V1::SyntheticsTriggerCITestsResponse](SyntheticsTriggerCITestsResponse.md) +- [DatadogAPIClient::V1::SyntheticsUpdateTestPauseStatusPayload](SyntheticsUpdateTestPauseStatusPayload.md) +- [DatadogAPIClient::V1::SyntheticsVariableParser](SyntheticsVariableParser.md) +- [DatadogAPIClient::V1::SyntheticsWarningType](SyntheticsWarningType.md) +- [DatadogAPIClient::V1::TableWidgetCellDisplayMode](TableWidgetCellDisplayMode.md) +- [DatadogAPIClient::V1::TableWidgetDefinition](TableWidgetDefinition.md) +- [DatadogAPIClient::V1::TableWidgetDefinitionType](TableWidgetDefinitionType.md) +- [DatadogAPIClient::V1::TableWidgetHasSearchBar](TableWidgetHasSearchBar.md) +- [DatadogAPIClient::V1::TableWidgetRequest](TableWidgetRequest.md) +- [DatadogAPIClient::V1::TagToHosts](TagToHosts.md) +- [DatadogAPIClient::V1::TargetFormatType](TargetFormatType.md) +- [DatadogAPIClient::V1::TimeseriesWidgetDefinition](TimeseriesWidgetDefinition.md) +- [DatadogAPIClient::V1::TimeseriesWidgetDefinitionType](TimeseriesWidgetDefinitionType.md) +- [DatadogAPIClient::V1::TimeseriesWidgetExpressionAlias](TimeseriesWidgetExpressionAlias.md) +- [DatadogAPIClient::V1::TimeseriesWidgetLegendColumn](TimeseriesWidgetLegendColumn.md) +- [DatadogAPIClient::V1::TimeseriesWidgetLegendLayout](TimeseriesWidgetLegendLayout.md) +- [DatadogAPIClient::V1::TimeseriesWidgetRequest](TimeseriesWidgetRequest.md) +- [DatadogAPIClient::V1::ToplistWidgetDefinition](ToplistWidgetDefinition.md) +- [DatadogAPIClient::V1::ToplistWidgetDefinitionType](ToplistWidgetDefinitionType.md) +- [DatadogAPIClient::V1::ToplistWidgetRequest](ToplistWidgetRequest.md) +- [DatadogAPIClient::V1::TreeMapColorBy](TreeMapColorBy.md) +- [DatadogAPIClient::V1::TreeMapGroupBy](TreeMapGroupBy.md) +- [DatadogAPIClient::V1::TreeMapSizeBy](TreeMapSizeBy.md) +- [DatadogAPIClient::V1::TreeMapWidgetDefinition](TreeMapWidgetDefinition.md) +- [DatadogAPIClient::V1::TreeMapWidgetDefinitionType](TreeMapWidgetDefinitionType.md) +- [DatadogAPIClient::V1::TreeMapWidgetRequest](TreeMapWidgetRequest.md) +- [DatadogAPIClient::V1::UsageAnalyzedLogsHour](UsageAnalyzedLogsHour.md) +- [DatadogAPIClient::V1::UsageAnalyzedLogsResponse](UsageAnalyzedLogsResponse.md) +- [DatadogAPIClient::V1::UsageAttributionAggregatesBody](UsageAttributionAggregatesBody.md) +- [DatadogAPIClient::V1::UsageAttributionBody](UsageAttributionBody.md) +- [DatadogAPIClient::V1::UsageAttributionMetadata](UsageAttributionMetadata.md) +- [DatadogAPIClient::V1::UsageAttributionPagination](UsageAttributionPagination.md) +- [DatadogAPIClient::V1::UsageAttributionResponse](UsageAttributionResponse.md) +- [DatadogAPIClient::V1::UsageAttributionSort](UsageAttributionSort.md) +- [DatadogAPIClient::V1::UsageAttributionSupportedMetrics](UsageAttributionSupportedMetrics.md) +- [DatadogAPIClient::V1::UsageAttributionValues](UsageAttributionValues.md) +- [DatadogAPIClient::V1::UsageAuditLogsHour](UsageAuditLogsHour.md) +- [DatadogAPIClient::V1::UsageAuditLogsResponse](UsageAuditLogsResponse.md) +- [DatadogAPIClient::V1::UsageBillableSummaryBody](UsageBillableSummaryBody.md) +- [DatadogAPIClient::V1::UsageBillableSummaryHour](UsageBillableSummaryHour.md) +- [DatadogAPIClient::V1::UsageBillableSummaryKeys](UsageBillableSummaryKeys.md) +- [DatadogAPIClient::V1::UsageBillableSummaryResponse](UsageBillableSummaryResponse.md) +- [DatadogAPIClient::V1::UsageCWSHour](UsageCWSHour.md) +- [DatadogAPIClient::V1::UsageCWSResponse](UsageCWSResponse.md) +- [DatadogAPIClient::V1::UsageCloudSecurityPostureManagementHour](UsageCloudSecurityPostureManagementHour.md) +- [DatadogAPIClient::V1::UsageCloudSecurityPostureManagementResponse](UsageCloudSecurityPostureManagementResponse.md) +- [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) +- [DatadogAPIClient::V1::UsageIncidentManagementResponse](UsageIncidentManagementResponse.md) +- [DatadogAPIClient::V1::UsageIndexedSpansHour](UsageIndexedSpansHour.md) +- [DatadogAPIClient::V1::UsageIndexedSpansResponse](UsageIndexedSpansResponse.md) +- [DatadogAPIClient::V1::UsageIngestedSpansHour](UsageIngestedSpansHour.md) +- [DatadogAPIClient::V1::UsageIngestedSpansResponse](UsageIngestedSpansResponse.md) +- [DatadogAPIClient::V1::UsageIoTHour](UsageIoTHour.md) +- [DatadogAPIClient::V1::UsageIoTResponse](UsageIoTResponse.md) +- [DatadogAPIClient::V1::UsageLambdaHour](UsageLambdaHour.md) +- [DatadogAPIClient::V1::UsageLambdaResponse](UsageLambdaResponse.md) +- [DatadogAPIClient::V1::UsageLogsByIndexHour](UsageLogsByIndexHour.md) +- [DatadogAPIClient::V1::UsageLogsByIndexResponse](UsageLogsByIndexResponse.md) +- [DatadogAPIClient::V1::UsageLogsByRetentionHour](UsageLogsByRetentionHour.md) +- [DatadogAPIClient::V1::UsageLogsByRetentionResponse](UsageLogsByRetentionResponse.md) +- [DatadogAPIClient::V1::UsageLogsHour](UsageLogsHour.md) +- [DatadogAPIClient::V1::UsageLogsResponse](UsageLogsResponse.md) +- [DatadogAPIClient::V1::UsageMetricCategory](UsageMetricCategory.md) +- [DatadogAPIClient::V1::UsageNetworkFlowsHour](UsageNetworkFlowsHour.md) +- [DatadogAPIClient::V1::UsageNetworkFlowsResponse](UsageNetworkFlowsResponse.md) +- [DatadogAPIClient::V1::UsageNetworkHostsHour](UsageNetworkHostsHour.md) +- [DatadogAPIClient::V1::UsageNetworkHostsResponse](UsageNetworkHostsResponse.md) +- [DatadogAPIClient::V1::UsageProfilingHour](UsageProfilingHour.md) +- [DatadogAPIClient::V1::UsageProfilingResponse](UsageProfilingResponse.md) +- [DatadogAPIClient::V1::UsageReportsType](UsageReportsType.md) +- [DatadogAPIClient::V1::UsageRumSessionsHour](UsageRumSessionsHour.md) +- [DatadogAPIClient::V1::UsageRumSessionsResponse](UsageRumSessionsResponse.md) +- [DatadogAPIClient::V1::UsageSDSHour](UsageSDSHour.md) +- [DatadogAPIClient::V1::UsageSDSResponse](UsageSDSResponse.md) +- [DatadogAPIClient::V1::UsageSNMPHour](UsageSNMPHour.md) +- [DatadogAPIClient::V1::UsageSNMPResponse](UsageSNMPResponse.md) +- [DatadogAPIClient::V1::UsageSort](UsageSort.md) +- [DatadogAPIClient::V1::UsageSortDirection](UsageSortDirection.md) +- [DatadogAPIClient::V1::UsageSpecifiedCustomReportsAttributes](UsageSpecifiedCustomReportsAttributes.md) +- [DatadogAPIClient::V1::UsageSpecifiedCustomReportsData](UsageSpecifiedCustomReportsData.md) +- [DatadogAPIClient::V1::UsageSpecifiedCustomReportsMeta](UsageSpecifiedCustomReportsMeta.md) +- [DatadogAPIClient::V1::UsageSpecifiedCustomReportsPage](UsageSpecifiedCustomReportsPage.md) +- [DatadogAPIClient::V1::UsageSpecifiedCustomReportsResponse](UsageSpecifiedCustomReportsResponse.md) +- [DatadogAPIClient::V1::UsageSummaryDate](UsageSummaryDate.md) +- [DatadogAPIClient::V1::UsageSummaryDateOrg](UsageSummaryDateOrg.md) +- [DatadogAPIClient::V1::UsageSummaryResponse](UsageSummaryResponse.md) +- [DatadogAPIClient::V1::UsageSyntheticsAPIHour](UsageSyntheticsAPIHour.md) +- [DatadogAPIClient::V1::UsageSyntheticsAPIResponse](UsageSyntheticsAPIResponse.md) +- [DatadogAPIClient::V1::UsageSyntheticsBrowserHour](UsageSyntheticsBrowserHour.md) +- [DatadogAPIClient::V1::UsageSyntheticsBrowserResponse](UsageSyntheticsBrowserResponse.md) +- [DatadogAPIClient::V1::UsageSyntheticsHour](UsageSyntheticsHour.md) +- [DatadogAPIClient::V1::UsageSyntheticsResponse](UsageSyntheticsResponse.md) +- [DatadogAPIClient::V1::UsageTimeseriesHour](UsageTimeseriesHour.md) +- [DatadogAPIClient::V1::UsageTimeseriesResponse](UsageTimeseriesResponse.md) +- [DatadogAPIClient::V1::UsageTopAvgMetricsHour](UsageTopAvgMetricsHour.md) +- [DatadogAPIClient::V1::UsageTopAvgMetricsMetadata](UsageTopAvgMetricsMetadata.md) +- [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) +- [DatadogAPIClient::V1::WidgetComparator](WidgetComparator.md) +- [DatadogAPIClient::V1::WidgetCompareTo](WidgetCompareTo.md) +- [DatadogAPIClient::V1::WidgetConditionalFormat](WidgetConditionalFormat.md) +- [DatadogAPIClient::V1::WidgetCustomLink](WidgetCustomLink.md) +- [DatadogAPIClient::V1::WidgetDefinition](WidgetDefinition.md) +- [DatadogAPIClient::V1::WidgetDisplayType](WidgetDisplayType.md) +- [DatadogAPIClient::V1::WidgetEvent](WidgetEvent.md) +- [DatadogAPIClient::V1::WidgetEventSize](WidgetEventSize.md) +- [DatadogAPIClient::V1::WidgetFieldSort](WidgetFieldSort.md) +- [DatadogAPIClient::V1::WidgetFormula](WidgetFormula.md) +- [DatadogAPIClient::V1::WidgetFormulaLimit](WidgetFormulaLimit.md) +- [DatadogAPIClient::V1::WidgetGrouping](WidgetGrouping.md) +- [DatadogAPIClient::V1::WidgetHorizontalAlign](WidgetHorizontalAlign.md) +- [DatadogAPIClient::V1::WidgetImageSizing](WidgetImageSizing.md) +- [DatadogAPIClient::V1::WidgetLayout](WidgetLayout.md) +- [DatadogAPIClient::V1::WidgetLayoutType](WidgetLayoutType.md) +- [DatadogAPIClient::V1::WidgetLineType](WidgetLineType.md) +- [DatadogAPIClient::V1::WidgetLineWidth](WidgetLineWidth.md) +- [DatadogAPIClient::V1::WidgetLiveSpan](WidgetLiveSpan.md) +- [DatadogAPIClient::V1::WidgetMargin](WidgetMargin.md) +- [DatadogAPIClient::V1::WidgetMarker](WidgetMarker.md) +- [DatadogAPIClient::V1::WidgetMessageDisplay](WidgetMessageDisplay.md) +- [DatadogAPIClient::V1::WidgetMonitorSummaryDisplayFormat](WidgetMonitorSummaryDisplayFormat.md) +- [DatadogAPIClient::V1::WidgetMonitorSummarySort](WidgetMonitorSummarySort.md) +- [DatadogAPIClient::V1::WidgetNodeType](WidgetNodeType.md) +- [DatadogAPIClient::V1::WidgetOrderBy](WidgetOrderBy.md) +- [DatadogAPIClient::V1::WidgetPalette](WidgetPalette.md) +- [DatadogAPIClient::V1::WidgetRequestStyle](WidgetRequestStyle.md) +- [DatadogAPIClient::V1::WidgetServiceSummaryDisplayFormat](WidgetServiceSummaryDisplayFormat.md) +- [DatadogAPIClient::V1::WidgetSizeFormat](WidgetSizeFormat.md) +- [DatadogAPIClient::V1::WidgetSort](WidgetSort.md) +- [DatadogAPIClient::V1::WidgetStyle](WidgetStyle.md) +- [DatadogAPIClient::V1::WidgetSummaryType](WidgetSummaryType.md) +- [DatadogAPIClient::V1::WidgetTextAlign](WidgetTextAlign.md) +- [DatadogAPIClient::V1::WidgetTickEdge](WidgetTickEdge.md) +- [DatadogAPIClient::V1::WidgetTime](WidgetTime.md) +- [DatadogAPIClient::V1::WidgetTimeWindows](WidgetTimeWindows.md) +- [DatadogAPIClient::V1::WidgetVerticalAlign](WidgetVerticalAlign.md) +- [DatadogAPIClient::V1::WidgetViewMode](WidgetViewMode.md) +- [DatadogAPIClient::V1::WidgetVizType](WidgetVizType.md) ## Documentation for Authorization - ### AuthZ - - **Type**: OAuth - **Flow**: accessCode - **Authorization URL**: /oauth2/v1/authorize -- **Scopes**: +- **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. @@ -906,29 +902,24 @@ Class | Method | HTTP request | Description ### apiKeyAuth - - **Type**: API key - **API key parameter name**: DD-API-KEY - **Location**: HTTP header ### apiKeyAuthQuery - - **Type**: API key - **API key parameter name**: api_key - **Location**: URL query string ### appKeyAuth - - **Type**: API key - **API key parameter name**: DD-APPLICATION-KEY - **Location**: HTTP header ### appKeyAuthQuery - - **Type**: API key - **API key parameter name**: application_key - **Location**: URL query string - diff --git a/docs/v1/ResponseMetaAttributes.md b/docs/v1/ResponseMetaAttributes.md index 51b4e80fdfc4..585fca2881ee 100644 --- a/docs/v1/ResponseMetaAttributes.md +++ b/docs/v1/ResponseMetaAttributes.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **page** | [**Pagination**](Pagination.md) | | [optional] | +| Name | Type | Description | Notes | +| -------- | ------------------------------- | ----------- | ---------- | +| **page** | [**Pagination**](Pagination.md) | | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::ResponseMetaAttributes.new( page: null ) ``` - diff --git a/docs/v1/SLOBulkDeleteError.md b/docs/v1/SLOBulkDeleteError.md index ed71b7165600..f246d392c030 100644 --- a/docs/v1/SLOBulkDeleteError.md +++ b/docs/v1/SLOBulkDeleteError.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **id** | **String** | The ID of the service level objective object associated with this error. | | -| **message** | **String** | The error message. | | -| **timeframe** | [**SLOErrorTimeframe**](SLOErrorTimeframe.md) | | | +| Name | Type | Description | Notes | +| ------------- | --------------------------------------------- | ------------------------------------------------------------------------ | ----- | +| **id** | **String** | The ID of the service level objective object associated with this error. | | +| **message** | **String** | The error message. | | +| **timeframe** | [**SLOErrorTimeframe**](SLOErrorTimeframe.md) | | | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::SLOBulkDeleteError.new( timeframe: null ) ``` - diff --git a/docs/v1/SLOBulkDeleteResponse.md b/docs/v1/SLOBulkDeleteResponse.md index b0286fa4b8f2..5cc0851561a6 100644 --- a/docs/v1/SLOBulkDeleteResponse.md +++ b/docs/v1/SLOBulkDeleteResponse.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**SLOBulkDeleteResponseData**](SLOBulkDeleteResponseData.md) | | [optional] | -| **errors** | [**Array<SLOBulkDeleteError>**](SLOBulkDeleteError.md) | Array of errors object returned. | [optional] | +| Name | Type | Description | Notes | +| ---------- | ------------------------------------------------------------- | -------------------------------- | ---------- | +| **data** | [**SLOBulkDeleteResponseData**](SLOBulkDeleteResponseData.md) | | [optional] | +| **errors** | [**Array<SLOBulkDeleteError>**](SLOBulkDeleteError.md) | Array of errors object returned. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::SLOBulkDeleteResponse.new( errors: null ) ``` - diff --git a/docs/v1/SLOBulkDeleteResponseData.md b/docs/v1/SLOBulkDeleteResponseData.md index 51c9d0aed3d8..a83837d44bcf 100644 --- a/docs/v1/SLOBulkDeleteResponseData.md +++ b/docs/v1/SLOBulkDeleteResponseData.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **deleted** | **Array<String>** | An array of service level objective object IDs that indicates which objects that were completely deleted. | [optional] | +| Name | Type | Description | Notes | +| ----------- | ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **deleted** | **Array<String>** | An array of service level objective object IDs that indicates which objects that were completely deleted. | [optional] | | **updated** | **Array<String>** | An array of service level objective object IDs that indicates which objects that were modified (objects for which at least one threshold was deleted, but that were not completely deleted). | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::SLOBulkDeleteResponseData.new( updated: null ) ``` - diff --git a/docs/v1/SLOCorrection.md b/docs/v1/SLOCorrection.md index 502b4f81ff62..1b35e4d7e333 100644 --- a/docs/v1/SLOCorrection.md +++ b/docs/v1/SLOCorrection.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**SLOCorrectionResponseAttributes**](SLOCorrectionResponseAttributes.md) | | [optional] | -| **id** | **String** | The ID of the SLO correction. | [optional] | -| **type** | [**SLOCorrectionType**](SLOCorrectionType.md) | | [optional][default to 'correction'] | +| Name | Type | Description | Notes | +| -------------- | ------------------------------------------------------------------------- | ----------------------------- | ------------------------------------------- | +| **attributes** | [**SLOCorrectionResponseAttributes**](SLOCorrectionResponseAttributes.md) | | [optional] | +| **id** | **String** | The ID of the SLO correction. | [optional] | +| **type** | [**SLOCorrectionType**](SLOCorrectionType.md) | | [optional][default to 'correction'] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::SLOCorrection.new( type: null ) ``` - diff --git a/docs/v1/SLOCorrectionCategory.md b/docs/v1/SLOCorrectionCategory.md index b91dbdc2151a..e527f93b594c 100644 --- a/docs/v1/SLOCorrectionCategory.md +++ b/docs/v1/SLOCorrectionCategory.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::SLOCorrectionCategory.new() ``` - diff --git a/docs/v1/SLOCorrectionCreateData.md b/docs/v1/SLOCorrectionCreateData.md index acc28dfbaac1..05d4f673e69f 100644 --- a/docs/v1/SLOCorrectionCreateData.md +++ b/docs/v1/SLOCorrectionCreateData.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**SLOCorrectionCreateRequestAttributes**](SLOCorrectionCreateRequestAttributes.md) | | [optional] | -| **type** | [**SLOCorrectionType**](SLOCorrectionType.md) | | [default to 'correction'] | +| Name | Type | Description | Notes | +| -------------- | ----------------------------------------------------------------------------------- | ----------- | --------------------------------- | +| **attributes** | [**SLOCorrectionCreateRequestAttributes**](SLOCorrectionCreateRequestAttributes.md) | | [optional] | +| **type** | [**SLOCorrectionType**](SLOCorrectionType.md) | | [default to 'correction'] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::SLOCorrectionCreateData.new( type: null ) ``` - diff --git a/docs/v1/SLOCorrectionCreateRequest.md b/docs/v1/SLOCorrectionCreateRequest.md index 5b99707c4a9e..7d67949bbe5e 100644 --- a/docs/v1/SLOCorrectionCreateRequest.md +++ b/docs/v1/SLOCorrectionCreateRequest.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**SLOCorrectionCreateData**](SLOCorrectionCreateData.md) | | [optional] | +| Name | Type | Description | Notes | +| -------- | --------------------------------------------------------- | ----------- | ---------- | +| **data** | [**SLOCorrectionCreateData**](SLOCorrectionCreateData.md) | | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::SLOCorrectionCreateRequest.new( data: null ) ``` - diff --git a/docs/v1/SLOCorrectionCreateRequestAttributes.md b/docs/v1/SLOCorrectionCreateRequestAttributes.md index c96aa716f403..feae22b581fc 100644 --- a/docs/v1/SLOCorrectionCreateRequestAttributes.md +++ b/docs/v1/SLOCorrectionCreateRequestAttributes.md @@ -2,14 +2,14 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **category** | [**SLOCorrectionCategory**](SLOCorrectionCategory.md) | | | -| **description** | **String** | Description of the correction being made. | [optional] | -| **_end** | **Integer** | Ending time of the correction in epoch seconds. | | -| **slo_id** | **String** | ID of the SLO that this correction will be applied to. | | -| **start** | **Integer** | Starting time of the correction in epoch seconds. | | -| **timezone** | **String** | The timezone to display in the UI for the correction times (defaults to \"UTC\"). | [optional] | +| Name | Type | Description | Notes | +| --------------- | ----------------------------------------------------- | ------------------------------------------------------------------------------------------- | ---------- | +| **category** | [**SLOCorrectionCategory**](SLOCorrectionCategory.md) | | | +| **description** | **String** | Description of the correction being made. | [optional] | +| **\_end** | **Integer** | Ending time of the correction in epoch seconds. | | +| **slo_id** | **String** | ID of the SLO that this correction will be applied to. | | +| **start** | **Integer** | Starting time of the correction in epoch seconds. | | +| **timezone** | **String** | The timezone to display in the UI for the correction times (defaults to \"UTC\"). | [optional] | ## Example @@ -25,4 +25,3 @@ instance = DatadogAPIClient::V1::SLOCorrectionCreateRequestAttributes.new( timezone: UTC ) ``` - diff --git a/docs/v1/SLOCorrectionListResponse.md b/docs/v1/SLOCorrectionListResponse.md index 90e485ac8f68..b75f371ed34f 100644 --- a/docs/v1/SLOCorrectionListResponse.md +++ b/docs/v1/SLOCorrectionListResponse.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**Array<SLOCorrection>**](SLOCorrection.md) | The list of of SLO corrections objects. | [optional] | -| **meta** | [**ResponseMetaAttributes**](ResponseMetaAttributes.md) | | [optional] | +| Name | Type | Description | Notes | +| -------- | ------------------------------------------------------- | --------------------------------------- | ---------- | +| **data** | [**Array<SLOCorrection>**](SLOCorrection.md) | The list of of SLO corrections objects. | [optional] | +| **meta** | [**ResponseMetaAttributes**](ResponseMetaAttributes.md) | | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::SLOCorrectionListResponse.new( meta: null ) ``` - diff --git a/docs/v1/SLOCorrectionResponse.md b/docs/v1/SLOCorrectionResponse.md index e4ffc94ead8b..f80d26a41612 100644 --- a/docs/v1/SLOCorrectionResponse.md +++ b/docs/v1/SLOCorrectionResponse.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**SLOCorrection**](SLOCorrection.md) | | [optional] | +| Name | Type | Description | Notes | +| -------- | ------------------------------------- | ----------- | ---------- | +| **data** | [**SLOCorrection**](SLOCorrection.md) | | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::SLOCorrectionResponse.new( data: null ) ``` - diff --git a/docs/v1/SLOCorrectionResponseAttributes.md b/docs/v1/SLOCorrectionResponseAttributes.md index 26b964842277..2988b97d842e 100644 --- a/docs/v1/SLOCorrectionResponseAttributes.md +++ b/docs/v1/SLOCorrectionResponseAttributes.md @@ -2,15 +2,15 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **category** | [**SLOCorrectionCategory**](SLOCorrectionCategory.md) | | [optional] | -| **creator** | [**Creator**](Creator.md) | | [optional] | -| **description** | **String** | Description of the correction being made. | [optional] | -| **_end** | **Integer** | Ending time of the correction in epoch seconds. | [optional] | -| **slo_id** | **String** | ID of the SLO that this correction will be applied to. | [optional] | -| **start** | **Integer** | Starting time of the correction in epoch seconds. | [optional] | -| **timezone** | **String** | The timezone to display in the UI for the correction times (defaults to \"UTC\"). | [optional] | +| Name | Type | Description | Notes | +| --------------- | ----------------------------------------------------- | ------------------------------------------------------------------------------------------- | ---------- | +| **category** | [**SLOCorrectionCategory**](SLOCorrectionCategory.md) | | [optional] | +| **creator** | [**Creator**](Creator.md) | | [optional] | +| **description** | **String** | Description of the correction being made. | [optional] | +| **\_end** | **Integer** | Ending time of the correction in epoch seconds. | [optional] | +| **slo_id** | **String** | ID of the SLO that this correction will be applied to. | [optional] | +| **start** | **Integer** | Starting time of the correction in epoch seconds. | [optional] | +| **timezone** | **String** | The timezone to display in the UI for the correction times (defaults to \"UTC\"). | [optional] | ## Example @@ -27,4 +27,3 @@ instance = DatadogAPIClient::V1::SLOCorrectionResponseAttributes.new( timezone: null ) ``` - diff --git a/docs/v1/SLOCorrectionType.md b/docs/v1/SLOCorrectionType.md index 07ca2b866e87..ab5b1933e197 100644 --- a/docs/v1/SLOCorrectionType.md +++ b/docs/v1/SLOCorrectionType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::SLOCorrectionType.new() ``` - diff --git a/docs/v1/SLOCorrectionUpdateData.md b/docs/v1/SLOCorrectionUpdateData.md index c9ce52cbce26..346f476a285a 100644 --- a/docs/v1/SLOCorrectionUpdateData.md +++ b/docs/v1/SLOCorrectionUpdateData.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**SLOCorrectionUpdateRequestAttributes**](SLOCorrectionUpdateRequestAttributes.md) | | [optional] | -| **type** | [**SLOCorrectionType**](SLOCorrectionType.md) | | [optional][default to 'correction'] | +| Name | Type | Description | Notes | +| -------------- | ----------------------------------------------------------------------------------- | ----------- | ------------------------------------------- | +| **attributes** | [**SLOCorrectionUpdateRequestAttributes**](SLOCorrectionUpdateRequestAttributes.md) | | [optional] | +| **type** | [**SLOCorrectionType**](SLOCorrectionType.md) | | [optional][default to 'correction'] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::SLOCorrectionUpdateData.new( type: null ) ``` - diff --git a/docs/v1/SLOCorrectionUpdateRequest.md b/docs/v1/SLOCorrectionUpdateRequest.md index 0f2298c52a32..4fbab1d05023 100644 --- a/docs/v1/SLOCorrectionUpdateRequest.md +++ b/docs/v1/SLOCorrectionUpdateRequest.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**SLOCorrectionUpdateData**](SLOCorrectionUpdateData.md) | | [optional] | +| Name | Type | Description | Notes | +| -------- | --------------------------------------------------------- | ----------- | ---------- | +| **data** | [**SLOCorrectionUpdateData**](SLOCorrectionUpdateData.md) | | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::SLOCorrectionUpdateRequest.new( data: null ) ``` - diff --git a/docs/v1/SLOCorrectionUpdateRequestAttributes.md b/docs/v1/SLOCorrectionUpdateRequestAttributes.md index f020862865e6..2ea240c5c04c 100644 --- a/docs/v1/SLOCorrectionUpdateRequestAttributes.md +++ b/docs/v1/SLOCorrectionUpdateRequestAttributes.md @@ -2,13 +2,13 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **category** | [**SLOCorrectionCategory**](SLOCorrectionCategory.md) | | [optional] | -| **description** | **String** | Description of the correction being made. | [optional] | -| **_end** | **Integer** | Ending time of the correction in epoch seconds. | [optional] | -| **start** | **Integer** | Starting time of the correction in epoch seconds. | [optional] | -| **timezone** | **String** | The timezone to display in the UI for the correction times (defaults to \"UTC\"). | [optional] | +| Name | Type | Description | Notes | +| --------------- | ----------------------------------------------------- | ------------------------------------------------------------------------------------------- | ---------- | +| **category** | [**SLOCorrectionCategory**](SLOCorrectionCategory.md) | | [optional] | +| **description** | **String** | Description of the correction being made. | [optional] | +| **\_end** | **Integer** | Ending time of the correction in epoch seconds. | [optional] | +| **start** | **Integer** | Starting time of the correction in epoch seconds. | [optional] | +| **timezone** | **String** | The timezone to display in the UI for the correction times (defaults to \"UTC\"). | [optional] | ## Example @@ -23,4 +23,3 @@ instance = DatadogAPIClient::V1::SLOCorrectionUpdateRequestAttributes.new( timezone: UTC ) ``` - diff --git a/docs/v1/SLODeleteResponse.md b/docs/v1/SLODeleteResponse.md index 48b2dee76f48..b16a00a5fab9 100644 --- a/docs/v1/SLODeleteResponse.md +++ b/docs/v1/SLODeleteResponse.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | **Array<String>** | An array containing the ID of the deleted service level objective object. | [optional] | +| Name | Type | Description | Notes | +| ---------- | ------------------------------ | -------------------------------------------------------------------------------- | ---------- | +| **data** | **Array<String>** | An array containing the ID of the deleted service level objective object. | [optional] | | **errors** | **Hash<String, String>** | An dictionary containing the ID of the SLO as key and a deletion error as value. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::SLODeleteResponse.new( errors: null ) ``` - diff --git a/docs/v1/SLOErrorTimeframe.md b/docs/v1/SLOErrorTimeframe.md index 3fbf9d0a1933..c994fe646d4a 100644 --- a/docs/v1/SLOErrorTimeframe.md +++ b/docs/v1/SLOErrorTimeframe.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::SLOErrorTimeframe.new() ``` - diff --git a/docs/v1/SLOHistoryMetrics.md b/docs/v1/SLOHistoryMetrics.md index 0fb292af2bb0..779837568308 100644 --- a/docs/v1/SLOHistoryMetrics.md +++ b/docs/v1/SLOHistoryMetrics.md @@ -2,16 +2,16 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **denominator** | [**SLOHistoryMetricsSeries**](SLOHistoryMetricsSeries.md) | | | -| **interval** | **Integer** | The aggregated query interval for the series data. It's implicit based on the query time window. | | -| **message** | **String** | Optional message if there are specific query issues/warnings. | [optional] | -| **numerator** | [**SLOHistoryMetricsSeries**](SLOHistoryMetricsSeries.md) | | | -| **query** | **String** | The combined numerator and denominator query CSV. | | -| **res_type** | **String** | The series result type. This mimics `batch_query` response type. | | -| **resp_version** | **Integer** | The series response version type. This mimics `batch_query` response type. | | -| **times** | **Array<Float>** | An array of query timestamps in EPOCH milliseconds | | +| Name | Type | Description | Notes | +| ---------------- | --------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------- | +| **denominator** | [**SLOHistoryMetricsSeries**](SLOHistoryMetricsSeries.md) | | | +| **interval** | **Integer** | The aggregated query interval for the series data. It's implicit based on the query time window. | | +| **message** | **String** | Optional message if there are specific query issues/warnings. | [optional] | +| **numerator** | [**SLOHistoryMetricsSeries**](SLOHistoryMetricsSeries.md) | | | +| **query** | **String** | The combined numerator and denominator query CSV. | | +| **res_type** | **String** | The series result type. This mimics `batch_query` response type. | | +| **resp_version** | **Integer** | The series response version type. This mimics `batch_query` response type. | | +| **times** | **Array<Float>** | An array of query timestamps in EPOCH milliseconds | | ## Example @@ -29,4 +29,3 @@ instance = DatadogAPIClient::V1::SLOHistoryMetrics.new( times: [] ) ``` - diff --git a/docs/v1/SLOHistoryMetricsSeries.md b/docs/v1/SLOHistoryMetricsSeries.md index 1988062d3568..a2d65ef4959b 100644 --- a/docs/v1/SLOHistoryMetricsSeries.md +++ b/docs/v1/SLOHistoryMetricsSeries.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **count** | **Integer** | Count of submitted metrics. | | -| **metadata** | [**SLOHistoryMetricsSeriesMetadata**](SLOHistoryMetricsSeriesMetadata.md) | | [optional] | -| **sum** | **Float** | Total sum of the query. | | -| **values** | **Array<Float>** | The query values for each metric. | | +| Name | Type | Description | Notes | +| ------------ | ------------------------------------------------------------------------- | --------------------------------- | ---------- | +| **count** | **Integer** | Count of submitted metrics. | | +| **metadata** | [**SLOHistoryMetricsSeriesMetadata**](SLOHistoryMetricsSeriesMetadata.md) | | [optional] | +| **sum** | **Float** | Total sum of the query. | | +| **values** | **Array<Float>** | The query values for each metric. | | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V1::SLOHistoryMetricsSeries.new( values: [] ) ``` - diff --git a/docs/v1/SLOHistoryMetricsSeriesMetadata.md b/docs/v1/SLOHistoryMetricsSeriesMetadata.md index 0ee5a9c775ad..59884c6acef0 100644 --- a/docs/v1/SLOHistoryMetricsSeriesMetadata.md +++ b/docs/v1/SLOHistoryMetricsSeriesMetadata.md @@ -2,14 +2,14 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **aggr** | **String** | Query aggregator function. | [optional] | -| **expression** | **String** | Query expression. | [optional] | -| **metric** | **String** | Query metric used. | [optional] | -| **query_index** | **Integer** | Query index from original combined query. | [optional] | -| **scope** | **String** | Query scope. | [optional] | -| **unit** | [**Array<SLOHistoryMetricsSeriesMetadataUnit>**](SLOHistoryMetricsSeriesMetadataUnit.md) | An array of metric units that contains up to two unit objects. For example, bytes represents one unit object and bytes per second represents two unit objects. If a metric query only has one unit object, the second array element is null. | [optional] | +| Name | Type | Description | Notes | +| --------------- | ---------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **aggr** | **String** | Query aggregator function. | [optional] | +| **expression** | **String** | Query expression. | [optional] | +| **metric** | **String** | Query metric used. | [optional] | +| **query_index** | **Integer** | Query index from original combined query. | [optional] | +| **scope** | **String** | Query scope. | [optional] | +| **unit** | [**Array<SLOHistoryMetricsSeriesMetadataUnit>**](SLOHistoryMetricsSeriesMetadataUnit.md) | An array of metric units that contains up to two unit objects. For example, bytes represents one unit object and bytes per second represents two unit objects. If a metric query only has one unit object, the second array element is null. | [optional] | ## Example @@ -25,4 +25,3 @@ instance = DatadogAPIClient::V1::SLOHistoryMetricsSeriesMetadata.new( unit: [{"family":"bytes","id":2,"name":"byte","plural":"bytes","scale_factor":1.0,"short_name":"B"},null] ) ``` - diff --git a/docs/v1/SLOHistoryMetricsSeriesMetadataUnit.md b/docs/v1/SLOHistoryMetricsSeriesMetadataUnit.md index 1c05a8f8cc27..8482ff0c166e 100644 --- a/docs/v1/SLOHistoryMetricsSeriesMetadataUnit.md +++ b/docs/v1/SLOHistoryMetricsSeriesMetadataUnit.md @@ -2,14 +2,14 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **family** | **String** | The family of metric unit, for example `bytes` is the family for `kibibyte`, `byte`, and `bit` units. | [optional] | -| **id** | **Integer** | The ID of the metric unit. | [optional] | -| **name** | **String** | The unit of the metric, for instance `byte`. | [optional] | -| **plural** | **String** | The plural Unit of metric, for instance `bytes`. | [optional] | -| **scale_factor** | **Float** | The scale factor of metric unit, for instance `1.0`. | [optional] | -| **short_name** | **String** | A shorter and abbreviated version of the metric unit, for instance `B`. | [optional] | +| Name | Type | Description | Notes | +| ---------------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **family** | **String** | The family of metric unit, for example `bytes` is the family for `kibibyte`, `byte`, and `bit` units. | [optional] | +| **id** | **Integer** | The ID of the metric unit. | [optional] | +| **name** | **String** | The unit of the metric, for instance `byte`. | [optional] | +| **plural** | **String** | The plural Unit of metric, for instance `bytes`. | [optional] | +| **scale_factor** | **Float** | The scale factor of metric unit, for instance `1.0`. | [optional] | +| **short_name** | **String** | A shorter and abbreviated version of the metric unit, for instance `B`. | [optional] | ## Example @@ -25,4 +25,3 @@ instance = DatadogAPIClient::V1::SLOHistoryMetricsSeriesMetadataUnit.new( short_name: null ) ``` - diff --git a/docs/v1/SLOHistoryMonitor.md b/docs/v1/SLOHistoryMonitor.md index 3725dce24d1d..ea07f68d2c7e 100644 --- a/docs/v1/SLOHistoryMonitor.md +++ b/docs/v1/SLOHistoryMonitor.md @@ -2,20 +2,20 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **error_budget_remaining** | **Hash<String, Float>** | A mapping of threshold `timeframe` to the remaining error budget. | [optional] | -| **errors** | [**Array<SLOHistoryResponseErrorWithType>**](SLOHistoryResponseErrorWithType.md) | An array of error objects returned while querying the history data for the service level objective. | [optional] | -| **group** | **String** | For groups in a grouped SLO, this is the group name. | [optional] | -| **history** | **Array<Array<Float>>** | For `monitor` based SLOs, this includes the aggregated history as arrays that include time series and uptime data where `0=monitor` is in `OK` state and `1=monitor` is in `alert` state. | [optional] | -| **monitor_modified** | **Integer** | For `monitor` based SLOs, this is the last modified timestamp in epoch seconds of the monitor. | [optional] | -| **monitor_type** | **String** | For `monitor` based SLOs, this describes the type of monitor. | [optional] | -| **name** | **String** | For groups in a grouped SLO, this is the group name. For monitors in a multi-monitor SLO, this is the monitor name. | [optional] | -| **precision** | **Float** | The amount of decimal places the SLI value is accurate to for the given from `&&` to timestamp. Use `span_precision` instead. | [optional] | -| **preview** | **Boolean** | For `monitor` based SLOs, when `true` this indicates that a replay is in progress to give an accurate uptime calculation. | [optional] | -| **sli_value** | **Float** | The current SLI value of the SLO over the history window. | [optional] | -| **span_precision** | **Float** | The amount of decimal places the SLI value is accurate to for the given from `&&` to timestamp. | [optional] | -| **uptime** | **Float** | Use `sli_value` instead. | [optional] | +| Name | Type | Description | Notes | +| -------------------------- | -------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **error_budget_remaining** | **Hash<String, Float>** | A mapping of threshold `timeframe` to the remaining error budget. | [optional] | +| **errors** | [**Array<SLOHistoryResponseErrorWithType>**](SLOHistoryResponseErrorWithType.md) | An array of error objects returned while querying the history data for the service level objective. | [optional] | +| **group** | **String** | For groups in a grouped SLO, this is the group name. | [optional] | +| **history** | **Array<Array<Float>>** | For `monitor` based SLOs, this includes the aggregated history as arrays that include time series and uptime data where `0=monitor` is in `OK` state and `1=monitor` is in `alert` state. | [optional] | +| **monitor_modified** | **Integer** | For `monitor` based SLOs, this is the last modified timestamp in epoch seconds of the monitor. | [optional] | +| **monitor_type** | **String** | For `monitor` based SLOs, this describes the type of monitor. | [optional] | +| **name** | **String** | For groups in a grouped SLO, this is the group name. For monitors in a multi-monitor SLO, this is the monitor name. | [optional] | +| **precision** | **Float** | The amount of decimal places the SLI value is accurate to for the given from `&&` to timestamp. Use `span_precision` instead. | [optional] | +| **preview** | **Boolean** | For `monitor` based SLOs, when `true` this indicates that a replay is in progress to give an accurate uptime calculation. | [optional] | +| **sli_value** | **Float** | The current SLI value of the SLO over the history window. | [optional] | +| **span_precision** | **Float** | The amount of decimal places the SLI value is accurate to for the given from `&&` to timestamp. | [optional] | +| **uptime** | **Float** | Use `sli_value` instead. | [optional] | ## Example @@ -37,4 +37,3 @@ instance = DatadogAPIClient::V1::SLOHistoryMonitor.new( uptime: 99.99 ) ``` - diff --git a/docs/v1/SLOHistoryResponse.md b/docs/v1/SLOHistoryResponse.md index 7a489f6ae1a0..c0e70a2d4755 100644 --- a/docs/v1/SLOHistoryResponse.md +++ b/docs/v1/SLOHistoryResponse.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**SLOHistoryResponseData**](SLOHistoryResponseData.md) | | [optional] | +| Name | Type | Description | Notes | +| ---------- | ---------------------------------------------------------------------- | --------------------------------------------------------------------------------- | ---------- | +| **data** | [**SLOHistoryResponseData**](SLOHistoryResponseData.md) | | [optional] | | **errors** | [**Array<SLOHistoryResponseError>**](SLOHistoryResponseError.md) | A list of errors while querying the history data for the service level objective. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::SLOHistoryResponse.new( errors: null ) ``` - diff --git a/docs/v1/SLOHistoryResponseData.md b/docs/v1/SLOHistoryResponseData.md index 4db363454d62..a12782b9c34d 100644 --- a/docs/v1/SLOHistoryResponseData.md +++ b/docs/v1/SLOHistoryResponseData.md @@ -2,18 +2,18 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **from_ts** | **Integer** | The `from` timestamp in epoch seconds. | [optional] | -| **group_by** | **Array<String>** | For `metric` based SLOs where the query includes a group-by clause, this represents the list of grouping parameters. This is not included in responses for `monitor` based SLOs. | [optional] | -| **groups** | [**Array<SLOHistoryMonitor>**](SLOHistoryMonitor.md) | For grouped SLOs, this represents SLI data for specific groups. This is not included in the responses for `metric` based SLOs. | [optional] | -| **monitors** | [**Array<SLOHistoryMonitor>**](SLOHistoryMonitor.md) | For multi-monitor SLOs, this represents SLI data for specific monitors. This is not included in the responses for `metric` based SLOs. | [optional] | -| **overall** | [**SLOHistorySLIData**](SLOHistorySLIData.md) | | [optional] | -| **series** | [**SLOHistoryMetrics**](SLOHistoryMetrics.md) | | [optional] | -| **thresholds** | [**Hash<String, SLOThreshold>**](SLOThreshold.md) | mapping of string timeframe to the SLO threshold. | [optional] | -| **to_ts** | **Integer** | The `to` timestamp in epoch seconds. | [optional] | -| **type** | [**SLOType**](SLOType.md) | | [optional] | -| **type_id** | [**SLOTypeNumeric**](SLOTypeNumeric.md) | | [optional] | +| Name | Type | Description | Notes | +| -------------- | ---------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **from_ts** | **Integer** | The `from` timestamp in epoch seconds. | [optional] | +| **group_by** | **Array<String>** | For `metric` based SLOs where the query includes a group-by clause, this represents the list of grouping parameters. This is not included in responses for `monitor` based SLOs. | [optional] | +| **groups** | [**Array<SLOHistoryMonitor>**](SLOHistoryMonitor.md) | For grouped SLOs, this represents SLI data for specific groups. This is not included in the responses for `metric` based SLOs. | [optional] | +| **monitors** | [**Array<SLOHistoryMonitor>**](SLOHistoryMonitor.md) | For multi-monitor SLOs, this represents SLI data for specific monitors. This is not included in the responses for `metric` based SLOs. | [optional] | +| **overall** | [**SLOHistorySLIData**](SLOHistorySLIData.md) | | [optional] | +| **series** | [**SLOHistoryMetrics**](SLOHistoryMetrics.md) | | [optional] | +| **thresholds** | [**Hash<String, SLOThreshold>**](SLOThreshold.md) | mapping of string timeframe to the SLO threshold. | [optional] | +| **to_ts** | **Integer** | The `to` timestamp in epoch seconds. | [optional] | +| **type** | [**SLOType**](SLOType.md) | | [optional] | +| **type_id** | [**SLOTypeNumeric**](SLOTypeNumeric.md) | | [optional] | ## Example @@ -33,4 +33,3 @@ instance = DatadogAPIClient::V1::SLOHistoryResponseData.new( type_id: null ) ``` - diff --git a/docs/v1/SLOHistoryResponseError.md b/docs/v1/SLOHistoryResponseError.md index ac904eb01f4a..ebed09e1b5f2 100644 --- a/docs/v1/SLOHistoryResponseError.md +++ b/docs/v1/SLOHistoryResponseError.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| --------- | ---------- | --------------------- | ---------- | | **error** | **String** | Human readable error. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::SLOHistoryResponseError.new( error: null ) ``` - diff --git a/docs/v1/SLOHistoryResponseErrorWithType.md b/docs/v1/SLOHistoryResponseErrorWithType.md index 420b86ddfce9..d3d6c75f299f 100644 --- a/docs/v1/SLOHistoryResponseErrorWithType.md +++ b/docs/v1/SLOHistoryResponseErrorWithType.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **error_message** | **String** | A message with more details about the error. | | -| **error_type** | **String** | Type of the error. | | +| Name | Type | Description | Notes | +| ----------------- | ---------- | -------------------------------------------- | ----- | +| **error_message** | **String** | A message with more details about the error. | | +| **error_type** | **String** | Type of the error. | | ## Example @@ -14,7 +14,6 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::SLOHistoryResponseErrorWithType.new( error_message: , - error_type: + error_type: ) ``` - diff --git a/docs/v1/SLOHistorySLIData.md b/docs/v1/SLOHistorySLIData.md index 1fd4c8d588a5..cce2af579c64 100644 --- a/docs/v1/SLOHistorySLIData.md +++ b/docs/v1/SLOHistorySLIData.md @@ -2,20 +2,20 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **error_budget_remaining** | **Hash<String, Float>** | A mapping of threshold `timeframe` to the remaining error budget. | [optional] | -| **errors** | [**Array<SLOHistoryResponseErrorWithType>**](SLOHistoryResponseErrorWithType.md) | An array of error objects returned while querying the history data for the service level objective. | [optional] | -| **group** | **String** | For groups in a grouped SLO, this is the group name. | [optional] | -| **history** | **Array<Array<Float>>** | For `monitor` based SLOs, this includes the aggregated history as arrays that include time series and uptime data where `0=monitor` is in `OK` state and `1=monitor` is in `alert` state. | [optional] | -| **monitor_modified** | **Integer** | For `monitor` based SLOs, this is the last modified timestamp in epoch seconds of the monitor. | [optional] | -| **monitor_type** | **String** | For `monitor` based SLOs, this describes the type of monitor. | [optional] | -| **name** | **String** | For groups in a grouped SLO, this is the group name. For monitors in a multi-monitor SLO, this is the monitor name. | [optional] | -| **precision** | **Hash<String, Float>** | A mapping of threshold `timeframe` to number of accurate decimals, regardless of the from && to timestamp. | [optional] | -| **preview** | **Boolean** | For `monitor` based SLOs, when `true` this indicates that a replay is in progress to give an accurate uptime calculation. | [optional] | -| **sli_value** | **Float** | The current SLI value of the SLO over the history window. | [optional] | -| **span_precision** | **Float** | The amount of decimal places the SLI value is accurate to for the given from `&&` to timestamp. | [optional] | -| **uptime** | **Float** | Use `sli_value` instead. | [optional] | +| Name | Type | Description | Notes | +| -------------------------- | -------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **error_budget_remaining** | **Hash<String, Float>** | A mapping of threshold `timeframe` to the remaining error budget. | [optional] | +| **errors** | [**Array<SLOHistoryResponseErrorWithType>**](SLOHistoryResponseErrorWithType.md) | An array of error objects returned while querying the history data for the service level objective. | [optional] | +| **group** | **String** | For groups in a grouped SLO, this is the group name. | [optional] | +| **history** | **Array<Array<Float>>** | For `monitor` based SLOs, this includes the aggregated history as arrays that include time series and uptime data where `0=monitor` is in `OK` state and `1=monitor` is in `alert` state. | [optional] | +| **monitor_modified** | **Integer** | For `monitor` based SLOs, this is the last modified timestamp in epoch seconds of the monitor. | [optional] | +| **monitor_type** | **String** | For `monitor` based SLOs, this describes the type of monitor. | [optional] | +| **name** | **String** | For groups in a grouped SLO, this is the group name. For monitors in a multi-monitor SLO, this is the monitor name. | [optional] | +| **precision** | **Hash<String, Float>** | A mapping of threshold `timeframe` to number of accurate decimals, regardless of the from && to timestamp. | [optional] | +| **preview** | **Boolean** | For `monitor` based SLOs, when `true` this indicates that a replay is in progress to give an accurate uptime calculation. | [optional] | +| **sli_value** | **Float** | The current SLI value of the SLO over the history window. | [optional] | +| **span_precision** | **Float** | The amount of decimal places the SLI value is accurate to for the given from `&&` to timestamp. | [optional] | +| **uptime** | **Float** | Use `sli_value` instead. | [optional] | ## Example @@ -37,4 +37,3 @@ instance = DatadogAPIClient::V1::SLOHistorySLIData.new( uptime: 99.99 ) ``` - diff --git a/docs/v1/SLOListResponse.md b/docs/v1/SLOListResponse.md index 1223a6faec24..9bd475b945dc 100644 --- a/docs/v1/SLOListResponse.md +++ b/docs/v1/SLOListResponse.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**Array<ServiceLevelObjective>**](ServiceLevelObjective.md) | An array of service level objective objects. | [optional] | -| **errors** | **Array<String>** | An array of error messages. Each endpoint documents how/whether this field is used. | [optional] | -| **metadata** | [**SLOListResponseMetadata**](SLOListResponseMetadata.md) | | [optional] | +| Name | Type | Description | Notes | +| ------------ | ------------------------------------------------------------------ | ----------------------------------------------------------------------------------- | ---------- | +| **data** | [**Array<ServiceLevelObjective>**](ServiceLevelObjective.md) | An array of service level objective objects. | [optional] | +| **errors** | **Array<String>** | An array of error messages. Each endpoint documents how/whether this field is used. | [optional] | +| **metadata** | [**SLOListResponseMetadata**](SLOListResponseMetadata.md) | | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::SLOListResponse.new( metadata: null ) ``` - diff --git a/docs/v1/SLOListResponseMetadata.md b/docs/v1/SLOListResponseMetadata.md index 5255e811388f..b2e2ad04a9e6 100644 --- a/docs/v1/SLOListResponseMetadata.md +++ b/docs/v1/SLOListResponseMetadata.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **page** | [**SLOListResponseMetadataPage**](SLOListResponseMetadataPage.md) | | [optional] | +| Name | Type | Description | Notes | +| -------- | ----------------------------------------------------------------- | ----------- | ---------- | +| **page** | [**SLOListResponseMetadataPage**](SLOListResponseMetadataPage.md) | | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::SLOListResponseMetadata.new( page: null ) ``` - diff --git a/docs/v1/SLOListResponseMetadataPage.md b/docs/v1/SLOListResponseMetadataPage.md index 7cf1facb8633..af744e46199f 100644 --- a/docs/v1/SLOListResponseMetadataPage.md +++ b/docs/v1/SLOListResponseMetadataPage.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **total_count** | **Integer** | The total number of resources that could be retrieved ignoring the parameters and filters in the request. | [optional] | +| Name | Type | Description | Notes | +| ------------------------ | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------- | +| **total_count** | **Integer** | The total number of resources that could be retrieved ignoring the parameters and filters in the request. | [optional] | | **total_filtered_count** | **Integer** | The total number of resources that match the parameters and filters in the request. This attribute can be used by a client to determine the total number of pages. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::SLOListResponseMetadataPage.new( total_filtered_count: null ) ``` - diff --git a/docs/v1/SLOResponse.md b/docs/v1/SLOResponse.md index f03705e2f9a8..5c19b6bf3c49 100644 --- a/docs/v1/SLOResponse.md +++ b/docs/v1/SLOResponse.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**SLOResponseData**](SLOResponseData.md) | | [optional] | -| **errors** | **Array<String>** | An array of error messages. Each endpoint documents how/whether this field is used. | [optional] | +| Name | Type | Description | Notes | +| ---------- | ----------------------------------------- | ----------------------------------------------------------------------------------- | ---------- | +| **data** | [**SLOResponseData**](SLOResponseData.md) | | [optional] | +| **errors** | **Array<String>** | An array of error messages. Each endpoint documents how/whether this field is used. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::SLOResponse.new( errors: null ) ``` - diff --git a/docs/v1/SLOResponseData.md b/docs/v1/SLOResponseData.md index 8e0305e33ed3..c314e076e3e1 100644 --- a/docs/v1/SLOResponseData.md +++ b/docs/v1/SLOResponseData.md @@ -2,22 +2,22 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **configured_alert_ids** | **Array<Integer>** | A list of SLO monitors IDs that reference this SLO. This field is returned only when `with_configured_alert_ids` parameter is true in query. | [optional] | -| **created_at** | **Integer** | Creation timestamp (UNIX time in seconds) Always included in service level objective responses. | [optional][readonly] | -| **creator** | [**Creator**](Creator.md) | | [optional] | -| **description** | **String** | A user-defined description of the service level objective. Always included in service level objective responses (but may be `null`). Optional in create/update requests. | [optional] | -| **groups** | **Array<String>** | A list of (up to 20) monitor groups that narrow the scope of a monitor service level objective. Included in service level objective responses if it is not empty. Optional in create/update requests for monitor service level objectives, but may only be used when then length of the `monitor_ids` field is one. | [optional] | -| **id** | **String** | A unique identifier for the service level objective object. Always included in service level objective responses. | [optional][readonly] | -| **modified_at** | **Integer** | Modification timestamp (UNIX time in seconds) Always included in service level objective responses. | [optional][readonly] | -| **monitor_ids** | **Array<Integer>** | A list of monitor ids that defines the scope of a monitor service level objective. **Required if type is `monitor`**. | [optional] | -| **monitor_tags** | **Array<String>** | The union of monitor tags for all monitors referenced by the `monitor_ids` field. Always included in service level objective responses for monitor service level objectives (but may be empty). Ignored in create/update requests. Does not affect which monitors are included in the service level objective (that is determined entirely by the `monitor_ids` field). | [optional] | -| **name** | **String** | The name of the service level objective object. | [optional] | -| **query** | [**ServiceLevelObjectiveQuery**](ServiceLevelObjectiveQuery.md) | | [optional] | -| **tags** | **Array<String>** | A list of tags associated with this service level objective. Always included in service level objective responses (but may be empty). Optional in create/update requests. | [optional] | -| **thresholds** | [**Array<SLOThreshold>**](SLOThreshold.md) | The thresholds (timeframes and associated targets) for this service level objective object. | [optional] | -| **type** | [**SLOType**](SLOType.md) | | [optional] | +| Name | Type | Description | Notes | +| ------------------------ | --------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- | +| **configured_alert_ids** | **Array<Integer>** | A list of SLO monitors IDs that reference this SLO. This field is returned only when `with_configured_alert_ids` parameter is true in query. | [optional] | +| **created_at** | **Integer** | Creation timestamp (UNIX time in seconds) Always included in service level objective responses. | [optional][readonly] | +| **creator** | [**Creator**](Creator.md) | | [optional] | +| **description** | **String** | A user-defined description of the service level objective. Always included in service level objective responses (but may be `null`). Optional in create/update requests. | [optional] | +| **groups** | **Array<String>** | A list of (up to 20) monitor groups that narrow the scope of a monitor service level objective. Included in service level objective responses if it is not empty. Optional in create/update requests for monitor service level objectives, but may only be used when then length of the `monitor_ids` field is one. | [optional] | +| **id** | **String** | A unique identifier for the service level objective object. Always included in service level objective responses. | [optional][readonly] | +| **modified_at** | **Integer** | Modification timestamp (UNIX time in seconds) Always included in service level objective responses. | [optional][readonly] | +| **monitor_ids** | **Array<Integer>** | A list of monitor ids that defines the scope of a monitor service level objective. **Required if type is `monitor`**. | [optional] | +| **monitor_tags** | **Array<String>** | The union of monitor tags for all monitors referenced by the `monitor_ids` field. Always included in service level objective responses for monitor service level objectives (but may be empty). Ignored in create/update requests. Does not affect which monitors are included in the service level objective (that is determined entirely by the `monitor_ids` field). | [optional] | +| **name** | **String** | The name of the service level objective object. | [optional] | +| **query** | [**ServiceLevelObjectiveQuery**](ServiceLevelObjectiveQuery.md) | | [optional] | +| **tags** | **Array<String>** | A list of tags associated with this service level objective. Always included in service level objective responses (but may be empty). Optional in create/update requests. | [optional] | +| **thresholds** | [**Array<SLOThreshold>**](SLOThreshold.md) | The thresholds (timeframes and associated targets) for this service level objective object. | [optional] | +| **type** | [**SLOType**](SLOType.md) | | [optional] | ## Example @@ -41,4 +41,3 @@ instance = DatadogAPIClient::V1::SLOResponseData.new( type: null ) ``` - diff --git a/docs/v1/SLOThreshold.md b/docs/v1/SLOThreshold.md index aef861542e9c..b70ca07793e6 100644 --- a/docs/v1/SLOThreshold.md +++ b/docs/v1/SLOThreshold.md @@ -2,13 +2,13 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **target** | **Float** | The target value for the service level indicator within the corresponding timeframe. | | -| **target_display** | **String** | A string representation of the target that indicates its precision. It uses trailing zeros to show significant decimal places (e.g. `98.00`). Always included in service level objective responses. Ignored in create/update requests. | [optional] | -| **timeframe** | [**SLOTimeframe**](SLOTimeframe.md) | | | -| **warning** | **Float** | The warning value for the service level objective. | [optional] | -| **warning_display** | **String** | A string representation of the warning target (see the description of the `target_display` field for details). Included in service level objective responses if a warning target exists. Ignored in create/update requests. | [optional] | +| Name | Type | Description | Notes | +| ------------------- | ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------- | +| **target** | **Float** | The target value for the service level indicator within the corresponding timeframe. | | +| **target_display** | **String** | A string representation of the target that indicates its precision. It uses trailing zeros to show significant decimal places (e.g. `98.00`). Always included in service level objective responses. Ignored in create/update requests. | [optional] | +| **timeframe** | [**SLOTimeframe**](SLOTimeframe.md) | | | +| **warning** | **Float** | The warning value for the service level objective. | [optional] | +| **warning_display** | **String** | A string representation of the warning target (see the description of the `target_display` field for details). Included in service level objective responses if a warning target exists. Ignored in create/update requests. | [optional] | ## Example @@ -23,4 +23,3 @@ instance = DatadogAPIClient::V1::SLOThreshold.new( warning_display: 90.0 ) ``` - diff --git a/docs/v1/SLOTimeframe.md b/docs/v1/SLOTimeframe.md index 4f0f445ece1d..29e3c0574415 100644 --- a/docs/v1/SLOTimeframe.md +++ b/docs/v1/SLOTimeframe.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::SLOTimeframe.new() ``` - diff --git a/docs/v1/SLOType.md b/docs/v1/SLOType.md index cf30d873a00e..ed54e9040f72 100644 --- a/docs/v1/SLOType.md +++ b/docs/v1/SLOType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::SLOType.new() ``` - diff --git a/docs/v1/SLOTypeNumeric.md b/docs/v1/SLOTypeNumeric.md index 7bc3624133a3..ef0a62d114eb 100644 --- a/docs/v1/SLOTypeNumeric.md +++ b/docs/v1/SLOTypeNumeric.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::SLOTypeNumeric.new() ``` - diff --git a/docs/v1/SLOWidgetDefinition.md b/docs/v1/SLOWidgetDefinition.md index b6751375b2fb..4741a42ca4e8 100644 --- a/docs/v1/SLOWidgetDefinition.md +++ b/docs/v1/SLOWidgetDefinition.md @@ -2,18 +2,18 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **global_time_target** | **String** | Defined global time target. | [optional] | -| **show_error_budget** | **Boolean** | Defined error budget. | [optional] | -| **slo_id** | **String** | ID of the SLO displayed. | [optional] | -| **time_windows** | [**Array<WidgetTimeWindows>**](WidgetTimeWindows.md) | Times being monitored. | [optional] | -| **title** | **String** | Title of the widget. | [optional] | -| **title_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | -| **title_size** | **String** | Size of the title. | [optional] | -| **type** | [**SLOWidgetDefinitionType**](SLOWidgetDefinitionType.md) | | [default to 'slo'] | -| **view_mode** | [**WidgetViewMode**](WidgetViewMode.md) | | [optional] | -| **view_type** | **String** | Type of view displayed by the widget. | [default to 'detail'] | +| Name | Type | Description | Notes | +| ---------------------- | ---------------------------------------------------------- | ------------------------------------- | ----------------------------- | +| **global_time_target** | **String** | Defined global time target. | [optional] | +| **show_error_budget** | **Boolean** | Defined error budget. | [optional] | +| **slo_id** | **String** | ID of the SLO displayed. | [optional] | +| **time_windows** | [**Array<WidgetTimeWindows>**](WidgetTimeWindows.md) | Times being monitored. | [optional] | +| **title** | **String** | Title of the widget. | [optional] | +| **title_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | +| **title_size** | **String** | Size of the title. | [optional] | +| **type** | [**SLOWidgetDefinitionType**](SLOWidgetDefinitionType.md) | | [default to 'slo'] | +| **view_mode** | [**WidgetViewMode**](WidgetViewMode.md) | | [optional] | +| **view_type** | **String** | Type of view displayed by the widget. | [default to 'detail'] | ## Example @@ -33,4 +33,3 @@ instance = DatadogAPIClient::V1::SLOWidgetDefinition.new( view_type: detail ) ``` - diff --git a/docs/v1/SLOWidgetDefinitionType.md b/docs/v1/SLOWidgetDefinitionType.md index f635fe7f4fe0..662d911b1a89 100644 --- a/docs/v1/SLOWidgetDefinitionType.md +++ b/docs/v1/SLOWidgetDefinitionType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::SLOWidgetDefinitionType.new() ``` - diff --git a/docs/v1/ScatterPlotRequest.md b/docs/v1/ScatterPlotRequest.md index e14c9f7f4d43..dc8b5bfa812b 100644 --- a/docs/v1/ScatterPlotRequest.md +++ b/docs/v1/ScatterPlotRequest.md @@ -2,18 +2,18 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **aggregator** | [**ScatterplotWidgetAggregator**](ScatterplotWidgetAggregator.md) | | [optional] | -| **apm_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **event_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **log_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **network_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **process_query** | [**ProcessQueryDefinition**](ProcessQueryDefinition.md) | | [optional] | -| **profile_metrics_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **q** | **String** | Query definition. | [optional] | -| **rum_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **security_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| Name | Type | Description | Notes | +| ------------------------- | ----------------------------------------------------------------- | ----------------- | ---------- | +| **aggregator** | [**ScatterplotWidgetAggregator**](ScatterplotWidgetAggregator.md) | | [optional] | +| **apm_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **event_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **log_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **network_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **process_query** | [**ProcessQueryDefinition**](ProcessQueryDefinition.md) | | [optional] | +| **profile_metrics_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **q** | **String** | Query definition. | [optional] | +| **rum_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **security_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | ## Example @@ -33,4 +33,3 @@ instance = DatadogAPIClient::V1::ScatterPlotRequest.new( security_query: null ) ``` - diff --git a/docs/v1/ScatterPlotWidgetDefinition.md b/docs/v1/ScatterPlotWidgetDefinition.md index 1da94d587ffd..16acefa89319 100644 --- a/docs/v1/ScatterPlotWidgetDefinition.md +++ b/docs/v1/ScatterPlotWidgetDefinition.md @@ -2,18 +2,18 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **color_by_groups** | **Array<String>** | List of groups used for colors. | [optional] | -| **custom_links** | [**Array<WidgetCustomLink>**](WidgetCustomLink.md) | List of custom links. | [optional] | -| **requests** | [**ScatterPlotWidgetDefinitionRequests**](ScatterPlotWidgetDefinitionRequests.md) | | | -| **time** | [**WidgetTime**](WidgetTime.md) | | [optional] | -| **title** | **String** | Title of your widget. | [optional] | -| **title_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | -| **title_size** | **String** | Size of the title. | [optional] | -| **type** | [**ScatterPlotWidgetDefinitionType**](ScatterPlotWidgetDefinitionType.md) | | [default to 'scatterplot'] | -| **xaxis** | [**WidgetAxis**](WidgetAxis.md) | | [optional] | -| **yaxis** | [**WidgetAxis**](WidgetAxis.md) | | [optional] | +| Name | Type | Description | Notes | +| ------------------- | --------------------------------------------------------------------------------- | ------------------------------- | ---------------------------------- | +| **color_by_groups** | **Array<String>** | List of groups used for colors. | [optional] | +| **custom_links** | [**Array<WidgetCustomLink>**](WidgetCustomLink.md) | List of custom links. | [optional] | +| **requests** | [**ScatterPlotWidgetDefinitionRequests**](ScatterPlotWidgetDefinitionRequests.md) | | | +| **time** | [**WidgetTime**](WidgetTime.md) | | [optional] | +| **title** | **String** | Title of your widget. | [optional] | +| **title_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | +| **title_size** | **String** | Size of the title. | [optional] | +| **type** | [**ScatterPlotWidgetDefinitionType**](ScatterPlotWidgetDefinitionType.md) | | [default to 'scatterplot'] | +| **xaxis** | [**WidgetAxis**](WidgetAxis.md) | | [optional] | +| **yaxis** | [**WidgetAxis**](WidgetAxis.md) | | [optional] | ## Example @@ -33,4 +33,3 @@ instance = DatadogAPIClient::V1::ScatterPlotWidgetDefinition.new( yaxis: null ) ``` - diff --git a/docs/v1/ScatterPlotWidgetDefinitionRequests.md b/docs/v1/ScatterPlotWidgetDefinitionRequests.md index 72ada84eb85f..8b41ffa8728d 100644 --- a/docs/v1/ScatterPlotWidgetDefinitionRequests.md +++ b/docs/v1/ScatterPlotWidgetDefinitionRequests.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **table** | [**ScatterplotTableRequest**](ScatterplotTableRequest.md) | | [optional] | -| **x** | [**ScatterPlotRequest**](ScatterPlotRequest.md) | | [optional] | -| **y** | [**ScatterPlotRequest**](ScatterPlotRequest.md) | | [optional] | +| Name | Type | Description | Notes | +| --------- | --------------------------------------------------------- | ----------- | ---------- | +| **table** | [**ScatterplotTableRequest**](ScatterplotTableRequest.md) | | [optional] | +| **x** | [**ScatterPlotRequest**](ScatterPlotRequest.md) | | [optional] | +| **y** | [**ScatterPlotRequest**](ScatterPlotRequest.md) | | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::ScatterPlotWidgetDefinitionRequests.new( y: null ) ``` - diff --git a/docs/v1/ScatterPlotWidgetDefinitionType.md b/docs/v1/ScatterPlotWidgetDefinitionType.md index d4f1d38d93d4..4cc2dd77fbbc 100644 --- a/docs/v1/ScatterPlotWidgetDefinitionType.md +++ b/docs/v1/ScatterPlotWidgetDefinitionType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::ScatterPlotWidgetDefinitionType.new() ``` - diff --git a/docs/v1/ScatterplotDimension.md b/docs/v1/ScatterplotDimension.md index 241b9172dda5..3e56d9a97fc6 100644 --- a/docs/v1/ScatterplotDimension.md +++ b/docs/v1/ScatterplotDimension.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::ScatterplotDimension.new() ``` - diff --git a/docs/v1/ScatterplotTableRequest.md b/docs/v1/ScatterplotTableRequest.md index 3ee341a6fa27..4148703983e7 100644 --- a/docs/v1/ScatterplotTableRequest.md +++ b/docs/v1/ScatterplotTableRequest.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **formulas** | [**Array<ScatterplotWidgetFormula>**](ScatterplotWidgetFormula.md) | List of Scatterplot formulas that operate on queries. **This feature is currently in beta.** | [optional] | -| **queries** | [**Array<FormulaAndFunctionQueryDefinition>**](FormulaAndFunctionQueryDefinition.md) | List of queries that can be returned directly or used in formulas. **This feature is currently in beta.** | [optional] | -| **response_format** | [**FormulaAndFunctionResponseFormat**](FormulaAndFunctionResponseFormat.md) | | [optional] | +| Name | Type | Description | Notes | +| ------------------- | ------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------- | ---------- | +| **formulas** | [**Array<ScatterplotWidgetFormula>**](ScatterplotWidgetFormula.md) | List of Scatterplot formulas that operate on queries. **This feature is currently in beta.** | [optional] | +| **queries** | [**Array<FormulaAndFunctionQueryDefinition>**](FormulaAndFunctionQueryDefinition.md) | List of queries that can be returned directly or used in formulas. **This feature is currently in beta.** | [optional] | +| **response_format** | [**FormulaAndFunctionResponseFormat**](FormulaAndFunctionResponseFormat.md) | | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::ScatterplotTableRequest.new( response_format: null ) ``` - diff --git a/docs/v1/ScatterplotWidgetAggregator.md b/docs/v1/ScatterplotWidgetAggregator.md index c098d12f1a33..75b85a20fc55 100644 --- a/docs/v1/ScatterplotWidgetAggregator.md +++ b/docs/v1/ScatterplotWidgetAggregator.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::ScatterplotWidgetAggregator.new() ``` - diff --git a/docs/v1/ScatterplotWidgetFormula.md b/docs/v1/ScatterplotWidgetFormula.md index d70989995c5d..c5465fdd091b 100644 --- a/docs/v1/ScatterplotWidgetFormula.md +++ b/docs/v1/ScatterplotWidgetFormula.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **_alias** | **String** | Expression alias. | [optional] | -| **dimension** | [**ScatterplotDimension**](ScatterplotDimension.md) | | | -| **formula** | **String** | String expression built from queries, formulas, and functions. | | +| Name | Type | Description | Notes | +| ------------- | --------------------------------------------------- | -------------------------------------------------------------- | ---------- | +| **\_alias** | **String** | Expression alias. | [optional] | +| **dimension** | [**ScatterplotDimension**](ScatterplotDimension.md) | | | +| **formula** | **String** | String expression built from queries, formulas, and functions. | | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::ScatterplotWidgetFormula.new( formula: func(a) + b ) ``` - diff --git a/docs/v1/Series.md b/docs/v1/Series.md index d11bcb61cb4d..86297ae367c9 100644 --- a/docs/v1/Series.md +++ b/docs/v1/Series.md @@ -2,14 +2,14 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **host** | **String** | The name of the host that produced the metric. | [optional] | -| **interval** | **Integer** | If the type of the metric is rate or count, define the corresponding interval. | [optional] | -| **metric** | **String** | The name of the timeseries. | | -| **points** | **Array<Array>** | Points relating to a metric. All points must be tuples with timestamp and a scalar value (cannot be a string). Timestamps should be in POSIX time in seconds, and cannot be more than ten minutes in the future or more than one hour in the past. | | -| **tags** | **Array<String>** | A list of tags associated with the metric. | [optional] | -| **type** | **String** | The type of the metric either `count`, `gauge`, or `rate`. | [optional][default to 'gauge'] | +| Name | Type | Description | Notes | +| ------------ | ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------- | +| **host** | **String** | The name of the host that produced the metric. | [optional] | +| **interval** | **Integer** | If the type of the metric is rate or count, define the corresponding interval. | [optional] | +| **metric** | **String** | The name of the timeseries. | | +| **points** | **Array<Array>** | Points relating to a metric. All points must be tuples with timestamp and a scalar value (cannot be a string). Timestamps should be in POSIX time in seconds, and cannot be more than ten minutes in the future or more than one hour in the past. | | +| **tags** | **Array<String>** | A list of tags associated with the metric. | [optional] | +| **type** | **String** | The type of the metric either `count`, `gauge`, or `rate`. | [optional][default to 'gauge'] | ## Example @@ -25,4 +25,3 @@ instance = DatadogAPIClient::V1::Series.new( type: rate ) ``` - diff --git a/docs/v1/ServiceCheck.md b/docs/v1/ServiceCheck.md index f328aa1d36b6..33ddc20a7255 100644 --- a/docs/v1/ServiceCheck.md +++ b/docs/v1/ServiceCheck.md @@ -2,14 +2,14 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **check** | **String** | The check. | | -| **host_name** | **String** | The host name correlated with the check. | | -| **message** | **String** | Message containing check status. | [optional] | -| **status** | [**ServiceCheckStatus**](ServiceCheckStatus.md) | | | -| **tags** | **Array<String>** | Tags related to a check. | | -| **timestamp** | **Integer** | Time of check. | [optional] | +| Name | Type | Description | Notes | +| ------------- | ----------------------------------------------- | ---------------------------------------- | ---------- | +| **check** | **String** | The check. | | +| **host_name** | **String** | The host name correlated with the check. | | +| **message** | **String** | Message containing check status. | [optional] | +| **status** | [**ServiceCheckStatus**](ServiceCheckStatus.md) | | | +| **tags** | **Array<String>** | Tags related to a check. | | +| **timestamp** | **Integer** | Time of check. | [optional] | ## Example @@ -25,4 +25,3 @@ instance = DatadogAPIClient::V1::ServiceCheck.new( timestamp: null ) ``` - diff --git a/docs/v1/ServiceCheckStatus.md b/docs/v1/ServiceCheckStatus.md index 944bd85c65bb..35541c13e4d3 100644 --- a/docs/v1/ServiceCheckStatus.md +++ b/docs/v1/ServiceCheckStatus.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::ServiceCheckStatus.new() ``` - diff --git a/docs/v1/ServiceChecksAPI.md b/docs/v1/ServiceChecksAPI.md index f04473a70981..bb2ffe79adea 100644 --- a/docs/v1/ServiceChecksAPI.md +++ b/docs/v1/ServiceChecksAPI.md @@ -2,11 +2,10 @@ All URIs are relative to *https://api.datadoghq.com* -| Method | HTTP request | Description | -| ------ | ------------ | ----------- | +| Method | HTTP request | Description | +| -------------------------------------------------------------------- | -------------------------- | ---------------------- | | [**submit_service_check**](ServiceChecksAPI.md#submit_service_check) | **POST** /api/v1/check_run | Submit a Service Check | - ## submit_service_check > submit_service_check(body) @@ -51,9 +50,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**Array<ServiceCheck>**](ServiceCheck.md) | Service Check request body. | | +| Name | Type | Description | Notes | +| -------- | ------------------------------------------------ | --------------------------- | ----- | +| **body** | [**Array<ServiceCheck>**](ServiceCheck.md) | Service Check request body. | | ### Return type @@ -67,4 +66,3 @@ end - **Content-Type**: application/json - **Accept**: text/json - diff --git a/docs/v1/ServiceLevelObjective.md b/docs/v1/ServiceLevelObjective.md index 7957488a04cd..eb6f5a8907f6 100644 --- a/docs/v1/ServiceLevelObjective.md +++ b/docs/v1/ServiceLevelObjective.md @@ -2,21 +2,21 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **created_at** | **Integer** | Creation timestamp (UNIX time in seconds) Always included in service level objective responses. | [optional][readonly] | -| **creator** | [**Creator**](Creator.md) | | [optional] | -| **description** | **String** | A user-defined description of the service level objective. Always included in service level objective responses (but may be `null`). Optional in create/update requests. | [optional] | -| **groups** | **Array<String>** | A list of (up to 20) monitor groups that narrow the scope of a monitor service level objective. Included in service level objective responses if it is not empty. Optional in create/update requests for monitor service level objectives, but may only be used when then length of the `monitor_ids` field is one. | [optional] | -| **id** | **String** | A unique identifier for the service level objective object. Always included in service level objective responses. | [optional][readonly] | -| **modified_at** | **Integer** | Modification timestamp (UNIX time in seconds) Always included in service level objective responses. | [optional][readonly] | -| **monitor_ids** | **Array<Integer>** | A list of monitor ids that defines the scope of a monitor service level objective. **Required if type is `monitor`**. | [optional] | -| **monitor_tags** | **Array<String>** | The union of monitor tags for all monitors referenced by the `monitor_ids` field. Always included in service level objective responses for monitor service level objectives (but may be empty). Ignored in create/update requests. Does not affect which monitors are included in the service level objective (that is determined entirely by the `monitor_ids` field). | [optional] | -| **name** | **String** | The name of the service level objective object. | | -| **query** | [**ServiceLevelObjectiveQuery**](ServiceLevelObjectiveQuery.md) | | [optional] | -| **tags** | **Array<String>** | A list of tags associated with this service level objective. Always included in service level objective responses (but may be empty). Optional in create/update requests. | [optional] | -| **thresholds** | [**Array<SLOThreshold>**](SLOThreshold.md) | The thresholds (timeframes and associated targets) for this service level objective object. | | -| **type** | [**SLOType**](SLOType.md) | | | +| Name | Type | Description | Notes | +| ---------------- | --------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- | +| **created_at** | **Integer** | Creation timestamp (UNIX time in seconds) Always included in service level objective responses. | [optional][readonly] | +| **creator** | [**Creator**](Creator.md) | | [optional] | +| **description** | **String** | A user-defined description of the service level objective. Always included in service level objective responses (but may be `null`). Optional in create/update requests. | [optional] | +| **groups** | **Array<String>** | A list of (up to 20) monitor groups that narrow the scope of a monitor service level objective. Included in service level objective responses if it is not empty. Optional in create/update requests for monitor service level objectives, but may only be used when then length of the `monitor_ids` field is one. | [optional] | +| **id** | **String** | A unique identifier for the service level objective object. Always included in service level objective responses. | [optional][readonly] | +| **modified_at** | **Integer** | Modification timestamp (UNIX time in seconds) Always included in service level objective responses. | [optional][readonly] | +| **monitor_ids** | **Array<Integer>** | A list of monitor ids that defines the scope of a monitor service level objective. **Required if type is `monitor`**. | [optional] | +| **monitor_tags** | **Array<String>** | The union of monitor tags for all monitors referenced by the `monitor_ids` field. Always included in service level objective responses for monitor service level objectives (but may be empty). Ignored in create/update requests. Does not affect which monitors are included in the service level objective (that is determined entirely by the `monitor_ids` field). | [optional] | +| **name** | **String** | The name of the service level objective object. | | +| **query** | [**ServiceLevelObjectiveQuery**](ServiceLevelObjectiveQuery.md) | | [optional] | +| **tags** | **Array<String>** | A list of tags associated with this service level objective. Always included in service level objective responses (but may be empty). Optional in create/update requests. | [optional] | +| **thresholds** | [**Array<SLOThreshold>**](SLOThreshold.md) | The thresholds (timeframes and associated targets) for this service level objective object. | | +| **type** | [**SLOType**](SLOType.md) | | | ## Example @@ -39,4 +39,3 @@ instance = DatadogAPIClient::V1::ServiceLevelObjective.new( type: null ) ``` - diff --git a/docs/v1/ServiceLevelObjectiveCorrectionsAPI.md b/docs/v1/ServiceLevelObjectiveCorrectionsAPI.md index 6bfcac516c70..7acc323fd6f8 100644 --- a/docs/v1/ServiceLevelObjectiveCorrectionsAPI.md +++ b/docs/v1/ServiceLevelObjectiveCorrectionsAPI.md @@ -2,14 +2,13 @@ All URIs are relative to *https://api.datadoghq.com* -| Method | HTTP request | Description | -| ------ | ------------ | ----------- | -| [**create_slo_correction**](ServiceLevelObjectiveCorrectionsAPI.md#create_slo_correction) | **POST** /api/v1/slo/correction | Create an SLO correction | -| [**delete_slo_correction**](ServiceLevelObjectiveCorrectionsAPI.md#delete_slo_correction) | **DELETE** /api/v1/slo/correction/{slo_correction_id} | Delete an SLO correction | -| [**get_slo_correction**](ServiceLevelObjectiveCorrectionsAPI.md#get_slo_correction) | **GET** /api/v1/slo/correction/{slo_correction_id} | Get an SLO correction for an SLO | -| [**list_slo_correction**](ServiceLevelObjectiveCorrectionsAPI.md#list_slo_correction) | **GET** /api/v1/slo/correction | Get all SLO corrections | -| [**update_slo_correction**](ServiceLevelObjectiveCorrectionsAPI.md#update_slo_correction) | **PATCH** /api/v1/slo/correction/{slo_correction_id} | Update an SLO correction | - +| Method | HTTP request | Description | +| ----------------------------------------------------------------------------------------- | ----------------------------------------------------- | -------------------------------- | +| [**create_slo_correction**](ServiceLevelObjectiveCorrectionsAPI.md#create_slo_correction) | **POST** /api/v1/slo/correction | Create an SLO correction | +| [**delete_slo_correction**](ServiceLevelObjectiveCorrectionsAPI.md#delete_slo_correction) | **DELETE** /api/v1/slo/correction/{slo_correction_id} | Delete an SLO correction | +| [**get_slo_correction**](ServiceLevelObjectiveCorrectionsAPI.md#get_slo_correction) | **GET** /api/v1/slo/correction/{slo_correction_id} | Get an SLO correction for an SLO | +| [**list_slo_correction**](ServiceLevelObjectiveCorrectionsAPI.md#list_slo_correction) | **GET** /api/v1/slo/correction | Get all SLO corrections | +| [**update_slo_correction**](ServiceLevelObjectiveCorrectionsAPI.md#update_slo_correction) | **PATCH** /api/v1/slo/correction/{slo_correction_id} | Update an SLO correction | ## create_slo_correction @@ -58,9 +57,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**SLOCorrectionCreateRequest**](SLOCorrectionCreateRequest.md) | Create an SLO Correction | | +| Name | Type | Description | Notes | +| -------- | --------------------------------------------------------------- | ------------------------ | ----- | +| **body** | [**SLOCorrectionCreateRequest**](SLOCorrectionCreateRequest.md) | Create an SLO Correction | | ### Return type @@ -75,7 +74,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## delete_slo_correction > delete_slo_correction(slo_correction_id) @@ -122,9 +120,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **slo_correction_id** | **String** | The ID of the SLO correction object. | | +| Name | Type | Description | Notes | +| --------------------- | ---------- | ------------------------------------ | ----- | +| **slo_correction_id** | **String** | The ID of the SLO correction object. | | ### Return type @@ -139,7 +137,6 @@ nil (empty response body) - **Content-Type**: Not defined - **Accept**: application/json - ## get_slo_correction > get_slo_correction(slo_correction_id) @@ -187,9 +184,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **slo_correction_id** | **String** | The ID of the SLO correction object. | | +| Name | Type | Description | Notes | +| --------------------- | ---------- | ------------------------------------ | ----- | +| **slo_correction_id** | **String** | The ID of the SLO correction object. | | ### Return type @@ -204,7 +201,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## list_slo_correction > list_slo_correction @@ -266,7 +262,6 @@ This endpoint does not need any parameter. - **Content-Type**: Not defined - **Accept**: application/json - ## update_slo_correction > update_slo_correction(slo_correction_id, body) @@ -315,10 +310,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **slo_correction_id** | **String** | The ID of the SLO correction object. | | -| **body** | [**SLOCorrectionUpdateRequest**](SLOCorrectionUpdateRequest.md) | The edited SLO correction object. | | +| Name | Type | Description | Notes | +| --------------------- | --------------------------------------------------------------- | ------------------------------------ | ----- | +| **slo_correction_id** | **String** | The ID of the SLO correction object. | | +| **body** | [**SLOCorrectionUpdateRequest**](SLOCorrectionUpdateRequest.md) | The edited SLO correction object. | | ### Return type @@ -332,4 +327,3 @@ end - **Content-Type**: application/json - **Accept**: application/json - diff --git a/docs/v1/ServiceLevelObjectiveQuery.md b/docs/v1/ServiceLevelObjectiveQuery.md index 9632c0a01d89..6414ac7080d5 100644 --- a/docs/v1/ServiceLevelObjectiveQuery.md +++ b/docs/v1/ServiceLevelObjectiveQuery.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **denominator** | **String** | A Datadog metric query for total (valid) events. | | -| **numerator** | **String** | A Datadog metric query for good events. | | +| Name | Type | Description | Notes | +| --------------- | ---------- | ------------------------------------------------ | ----- | +| **denominator** | **String** | A Datadog metric query for total (valid) events. | | +| **numerator** | **String** | A Datadog metric query for good events. | | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::ServiceLevelObjectiveQuery.new( numerator: sum:my.custom.metric{type:good}.as_count() ) ``` - diff --git a/docs/v1/ServiceLevelObjectiveRequest.md b/docs/v1/ServiceLevelObjectiveRequest.md index b88ee9aff327..16ccf538c7cd 100644 --- a/docs/v1/ServiceLevelObjectiveRequest.md +++ b/docs/v1/ServiceLevelObjectiveRequest.md @@ -2,16 +2,16 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **description** | **String** | A user-defined description of the service level objective. Always included in service level objective responses (but may be `null`). Optional in create/update requests. | [optional] | -| **groups** | **Array<String>** | A list of (up to 20) monitor groups that narrow the scope of a monitor service level objective. Included in service level objective responses if it is not empty. Optional in create/update requests for monitor service level objectives, but may only be used when then length of the `monitor_ids` field is one. | [optional] | -| **monitor_ids** | **Array<Integer>** | A list of monitor ids that defines the scope of a monitor service level objective. **Required if type is `monitor`**. | [optional] | -| **name** | **String** | The name of the service level objective object. | | -| **query** | [**ServiceLevelObjectiveQuery**](ServiceLevelObjectiveQuery.md) | | [optional] | -| **tags** | **Array<String>** | A list of tags associated with this service level objective. Always included in service level objective responses (but may be empty). Optional in create/update requests. | [optional] | -| **thresholds** | [**Array<SLOThreshold>**](SLOThreshold.md) | The thresholds (timeframes and associated targets) for this service level objective object. | | -| **type** | [**SLOType**](SLOType.md) | | | +| Name | Type | Description | Notes | +| --------------- | --------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **description** | **String** | A user-defined description of the service level objective. Always included in service level objective responses (but may be `null`). Optional in create/update requests. | [optional] | +| **groups** | **Array<String>** | A list of (up to 20) monitor groups that narrow the scope of a monitor service level objective. Included in service level objective responses if it is not empty. Optional in create/update requests for monitor service level objectives, but may only be used when then length of the `monitor_ids` field is one. | [optional] | +| **monitor_ids** | **Array<Integer>** | A list of monitor ids that defines the scope of a monitor service level objective. **Required if type is `monitor`**. | [optional] | +| **name** | **String** | The name of the service level objective object. | | +| **query** | [**ServiceLevelObjectiveQuery**](ServiceLevelObjectiveQuery.md) | | [optional] | +| **tags** | **Array<String>** | A list of tags associated with this service level objective. Always included in service level objective responses (but may be empty). Optional in create/update requests. | [optional] | +| **thresholds** | [**Array<SLOThreshold>**](SLOThreshold.md) | The thresholds (timeframes and associated targets) for this service level objective object. | | +| **type** | [**SLOType**](SLOType.md) | | | ## Example @@ -29,4 +29,3 @@ instance = DatadogAPIClient::V1::ServiceLevelObjectiveRequest.new( type: null ) ``` - diff --git a/docs/v1/ServiceLevelObjectivesAPI.md b/docs/v1/ServiceLevelObjectivesAPI.md index 3357a8715bf0..8785a3123915 100644 --- a/docs/v1/ServiceLevelObjectivesAPI.md +++ b/docs/v1/ServiceLevelObjectivesAPI.md @@ -2,17 +2,16 @@ All URIs are relative to *https://api.datadoghq.com* -| Method | HTTP request | Description | -| ------ | ------------ | ----------- | -| [**check_can_delete_slo**](ServiceLevelObjectivesAPI.md#check_can_delete_slo) | **GET** /api/v1/slo/can_delete | Check if SLOs can be safely deleted | -| [**create_slo**](ServiceLevelObjectivesAPI.md#create_slo) | **POST** /api/v1/slo | Create an SLO object | -| [**delete_slo**](ServiceLevelObjectivesAPI.md#delete_slo) | **DELETE** /api/v1/slo/{slo_id} | Delete an SLO | -| [**delete_slo_timeframe_in_bulk**](ServiceLevelObjectivesAPI.md#delete_slo_timeframe_in_bulk) | **POST** /api/v1/slo/bulk_delete | Bulk Delete SLO Timeframes | -| [**get_slo**](ServiceLevelObjectivesAPI.md#get_slo) | **GET** /api/v1/slo/{slo_id} | Get an SLO's details | -| [**get_slo_history**](ServiceLevelObjectivesAPI.md#get_slo_history) | **GET** /api/v1/slo/{slo_id}/history | Get an SLO's history | -| [**list_slos**](ServiceLevelObjectivesAPI.md#list_slos) | **GET** /api/v1/slo | Get all SLOs | -| [**update_slo**](ServiceLevelObjectivesAPI.md#update_slo) | **PUT** /api/v1/slo/{slo_id} | Update an SLO | - +| Method | HTTP request | Description | +| --------------------------------------------------------------------------------------------- | ------------------------------------ | ----------------------------------- | +| [**check_can_delete_slo**](ServiceLevelObjectivesAPI.md#check_can_delete_slo) | **GET** /api/v1/slo/can_delete | Check if SLOs can be safely deleted | +| [**create_slo**](ServiceLevelObjectivesAPI.md#create_slo) | **POST** /api/v1/slo | Create an SLO object | +| [**delete_slo**](ServiceLevelObjectivesAPI.md#delete_slo) | **DELETE** /api/v1/slo/{slo_id} | Delete an SLO | +| [**delete_slo_timeframe_in_bulk**](ServiceLevelObjectivesAPI.md#delete_slo_timeframe_in_bulk) | **POST** /api/v1/slo/bulk_delete | Bulk Delete SLO Timeframes | +| [**get_slo**](ServiceLevelObjectivesAPI.md#get_slo) | **GET** /api/v1/slo/{slo_id} | Get an SLO's details | +| [**get_slo_history**](ServiceLevelObjectivesAPI.md#get_slo_history) | **GET** /api/v1/slo/{slo_id}/history | Get an SLO's history | +| [**list_slos**](ServiceLevelObjectivesAPI.md#list_slos) | **GET** /api/v1/slo | Get all SLOs | +| [**update_slo**](ServiceLevelObjectivesAPI.md#update_slo) | **PUT** /api/v1/slo/{slo_id} | Update an SLO | ## check_can_delete_slo @@ -57,9 +56,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **ids** | **String** | A comma separated list of the IDs of the service level objectives objects. | | +| Name | Type | Description | Notes | +| ------- | ---------- | -------------------------------------------------------------------------- | ----- | +| **ids** | **String** | A comma separated list of the IDs of the service level objectives objects. | | ### Return type @@ -74,7 +73,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## create_slo > create_slo(body) @@ -117,9 +115,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**ServiceLevelObjectiveRequest**](ServiceLevelObjectiveRequest.md) | Service level objective request object. | | +| Name | Type | Description | Notes | +| -------- | ------------------------------------------------------------------- | --------------------------------------- | ----- | +| **body** | [**ServiceLevelObjectiveRequest**](ServiceLevelObjectiveRequest.md) | Service level objective request object. | | ### Return type @@ -134,7 +132,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## delete_slo > delete_slo(slo_id, opts) @@ -183,10 +180,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **slo_id** | **String** | The ID of the service level objective. | | -| **force** | **String** | Delete the monitor even if it's referenced by other resources (e.g. SLO, composite monitor). | [optional] | +| Name | Type | Description | Notes | +| ---------- | ---------- | ------------------------------------------------------------------------------------------------ | ---------- | +| **slo_id** | **String** | The ID of the service level objective. | | +| **force** | **String** | Delete the monitor even if it's referenced by other resources (e.g. SLO, composite monitor). | [optional] | ### Return type @@ -201,7 +198,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## delete_slo_timeframe_in_bulk > delete_slo_timeframe_in_bulk(body) @@ -248,9 +244,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | **Hash<String,Array<SLOTimeframe>>** | Delete multiple service level objective objects request body. | | +| Name | Type | Description | Notes | +| -------- | ------------------------------------------------ | ------------------------------------------------------------- | ----- | +| **body** | **Hash<String,Array<SLOTimeframe>>** | Delete multiple service level objective objects request body. | | ### Return type @@ -265,7 +261,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## get_slo > get_slo(slo_id, opts) @@ -311,9 +306,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **slo_id** | **String** | The ID of the service level objective object. | | +| Name | Type | Description | Notes | +| ----------------------------- | ----------- | ---------------------------------------------------- | ---------- | +| **slo_id** | **String** | The ID of the service level objective object. | | | **with_configured_alert_ids** | **Boolean** | Get the IDs of SLO monitors that reference this SLO. | [optional] | ### Return type @@ -329,7 +324,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## get_slo_history > get_slo_history(slo_id, from_ts, to_ts, opts) @@ -389,12 +383,12 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **slo_id** | **String** | The ID of the service level objective object. | | -| **from_ts** | **Integer** | The `from` timestamp for the query window in epoch seconds. | | -| **to_ts** | **Integer** | The `to` timestamp for the query window in epoch seconds. | | -| **target** | **Float** | The SLO target. If `target` is passed in, the response will include the remaining error budget and a timeframe value of `custom`. | [optional] | +| Name | Type | Description | Notes | +| ----------- | ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **slo_id** | **String** | The ID of the service level objective object. | | +| **from_ts** | **Integer** | The `from` timestamp for the query window in epoch seconds. | | +| **to_ts** | **Integer** | The `to` timestamp for the query window in epoch seconds. | | +| **target** | **Float** | The SLO target. If `target` is passed in, the response will include the remaining error budget and a timeframe value of `custom`. | [optional] | ### Return type @@ -409,7 +403,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## list_slos > list_slos(opts) @@ -459,14 +452,14 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **ids** | **String** | A comma separated list of the IDs of the service level objectives objects. | [optional] | -| **query** | **String** | The query string to filter results based on SLO names. | [optional] | -| **tags_query** | **String** | The query string to filter results based on a single SLO tag. | [optional] | -| **metrics_query** | **String** | The query string to filter results based on SLO numerator and denominator. | [optional] | -| **limit** | **Integer** | The number of SLOs to return in the response. | [optional] | -| **offset** | **Integer** | The specific offset to use as the beginning of the returned response. | [optional] | +| Name | Type | Description | Notes | +| ----------------- | ----------- | -------------------------------------------------------------------------- | ---------- | +| **ids** | **String** | A comma separated list of the IDs of the service level objectives objects. | [optional] | +| **query** | **String** | The query string to filter results based on SLO names. | [optional] | +| **tags_query** | **String** | The query string to filter results based on a single SLO tag. | [optional] | +| **metrics_query** | **String** | The query string to filter results based on SLO numerator and denominator. | [optional] | +| **limit** | **Integer** | The number of SLOs to return in the response. | [optional] | +| **offset** | **Integer** | The specific offset to use as the beginning of the returned response. | [optional] | ### Return type @@ -481,7 +474,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## update_slo > update_slo(slo_id, body) @@ -525,10 +517,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **slo_id** | **String** | The ID of the service level objective object. | | -| **body** | [**ServiceLevelObjective**](ServiceLevelObjective.md) | The edited service level objective request object. | | +| Name | Type | Description | Notes | +| ---------- | ----------------------------------------------------- | -------------------------------------------------- | ----- | +| **slo_id** | **String** | The ID of the service level objective object. | | +| **body** | [**ServiceLevelObjective**](ServiceLevelObjective.md) | The edited service level objective request object. | | ### Return type @@ -542,4 +534,3 @@ end - **Content-Type**: application/json - **Accept**: application/json - diff --git a/docs/v1/ServiceMapWidgetDefinition.md b/docs/v1/ServiceMapWidgetDefinition.md index 57e24d636951..9d9969cd71a0 100644 --- a/docs/v1/ServiceMapWidgetDefinition.md +++ b/docs/v1/ServiceMapWidgetDefinition.md @@ -2,15 +2,15 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **custom_links** | [**Array<WidgetCustomLink>**](WidgetCustomLink.md) | List of custom links. | [optional] | -| **filters** | **Array<String>** | Your environment and primary tag (or * if enabled for your account). | | -| **service** | **String** | The ID of the service you want to map. | | -| **title** | **String** | The title of your widget. | [optional] | -| **title_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | -| **title_size** | **String** | Size of the title. | [optional] | -| **type** | [**ServiceMapWidgetDefinitionType**](ServiceMapWidgetDefinitionType.md) | | [default to 'servicemap'] | +| Name | Type | Description | Notes | +| ---------------- | ----------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------- | +| **custom_links** | [**Array<WidgetCustomLink>**](WidgetCustomLink.md) | List of custom links. | [optional] | +| **filters** | **Array<String>** | Your environment and primary tag (or \* if enabled for your account). | | +| **service** | **String** | The ID of the service you want to map. | | +| **title** | **String** | The title of your widget. | [optional] | +| **title_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | +| **title_size** | **String** | Size of the title. | [optional] | +| **type** | [**ServiceMapWidgetDefinitionType**](ServiceMapWidgetDefinitionType.md) | | [default to 'servicemap'] | ## Example @@ -27,4 +27,3 @@ instance = DatadogAPIClient::V1::ServiceMapWidgetDefinition.new( type: null ) ``` - diff --git a/docs/v1/ServiceMapWidgetDefinitionType.md b/docs/v1/ServiceMapWidgetDefinitionType.md index 51dee2854a0a..82fc0caa5038 100644 --- a/docs/v1/ServiceMapWidgetDefinitionType.md +++ b/docs/v1/ServiceMapWidgetDefinitionType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::ServiceMapWidgetDefinitionType.new() ``` - diff --git a/docs/v1/ServiceSummaryWidgetDefinition.md b/docs/v1/ServiceSummaryWidgetDefinition.md index 9a10bbe3acac..1a779c45d2cb 100644 --- a/docs/v1/ServiceSummaryWidgetDefinition.md +++ b/docs/v1/ServiceSummaryWidgetDefinition.md @@ -2,24 +2,24 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **display_format** | [**WidgetServiceSummaryDisplayFormat**](WidgetServiceSummaryDisplayFormat.md) | | [optional] | -| **env** | **String** | APM environment. | | -| **service** | **String** | APM service. | | -| **show_breakdown** | **Boolean** | Whether to show the latency breakdown or not. | [optional] | -| **show_distribution** | **Boolean** | Whether to show the latency distribution or not. | [optional] | -| **show_errors** | **Boolean** | Whether to show the error metrics or not. | [optional] | -| **show_hits** | **Boolean** | Whether to show the hits metrics or not. | [optional] | -| **show_latency** | **Boolean** | Whether to show the latency metrics or not. | [optional] | -| **show_resource_list** | **Boolean** | Whether to show the resource list or not. | [optional] | -| **size_format** | [**WidgetSizeFormat**](WidgetSizeFormat.md) | | [optional] | -| **span_name** | **String** | APM span name. | | -| **time** | [**WidgetTime**](WidgetTime.md) | | [optional] | -| **title** | **String** | Title of the widget. | [optional] | -| **title_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | -| **title_size** | **String** | Size of the title. | [optional] | -| **type** | [**ServiceSummaryWidgetDefinitionType**](ServiceSummaryWidgetDefinitionType.md) | | [default to 'trace_service'] | +| Name | Type | Description | Notes | +| ---------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------ | ------------------------------------ | +| **display_format** | [**WidgetServiceSummaryDisplayFormat**](WidgetServiceSummaryDisplayFormat.md) | | [optional] | +| **env** | **String** | APM environment. | | +| **service** | **String** | APM service. | | +| **show_breakdown** | **Boolean** | Whether to show the latency breakdown or not. | [optional] | +| **show_distribution** | **Boolean** | Whether to show the latency distribution or not. | [optional] | +| **show_errors** | **Boolean** | Whether to show the error metrics or not. | [optional] | +| **show_hits** | **Boolean** | Whether to show the hits metrics or not. | [optional] | +| **show_latency** | **Boolean** | Whether to show the latency metrics or not. | [optional] | +| **show_resource_list** | **Boolean** | Whether to show the resource list or not. | [optional] | +| **size_format** | [**WidgetSizeFormat**](WidgetSizeFormat.md) | | [optional] | +| **span_name** | **String** | APM span name. | | +| **time** | [**WidgetTime**](WidgetTime.md) | | [optional] | +| **title** | **String** | Title of the widget. | [optional] | +| **title_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | +| **title_size** | **String** | Size of the title. | [optional] | +| **type** | [**ServiceSummaryWidgetDefinitionType**](ServiceSummaryWidgetDefinitionType.md) | | [default to 'trace_service'] | ## Example @@ -45,4 +45,3 @@ instance = DatadogAPIClient::V1::ServiceSummaryWidgetDefinition.new( type: null ) ``` - diff --git a/docs/v1/ServiceSummaryWidgetDefinitionType.md b/docs/v1/ServiceSummaryWidgetDefinitionType.md index f64d05516e51..bacc93ff1f2c 100644 --- a/docs/v1/ServiceSummaryWidgetDefinitionType.md +++ b/docs/v1/ServiceSummaryWidgetDefinitionType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::ServiceSummaryWidgetDefinitionType.new() ``` - diff --git a/docs/v1/SlackIntegrationAPI.md b/docs/v1/SlackIntegrationAPI.md index c65adc498c5b..4fc003ba402d 100644 --- a/docs/v1/SlackIntegrationAPI.md +++ b/docs/v1/SlackIntegrationAPI.md @@ -2,14 +2,13 @@ All URIs are relative to *https://api.datadoghq.com* -| Method | HTTP request | Description | -| ------ | ------------ | ----------- | -| [**create_slack_integration_channel**](SlackIntegrationAPI.md#create_slack_integration_channel) | **POST** /api/v1/integration/slack/configuration/accounts/{account_name}/channels | Create a Slack integration channel | -| [**get_slack_integration_channel**](SlackIntegrationAPI.md#get_slack_integration_channel) | **GET** /api/v1/integration/slack/configuration/accounts/{account_name}/channels/{channel_name} | Get a Slack integration channel | -| [**get_slack_integration_channels**](SlackIntegrationAPI.md#get_slack_integration_channels) | **GET** /api/v1/integration/slack/configuration/accounts/{account_name}/channels | Get all channels in a Slack integration | -| [**remove_slack_integration_channel**](SlackIntegrationAPI.md#remove_slack_integration_channel) | **DELETE** /api/v1/integration/slack/configuration/accounts/{account_name}/channels/{channel_name} | Remove a Slack integration channel | -| [**update_slack_integration_channel**](SlackIntegrationAPI.md#update_slack_integration_channel) | **PATCH** /api/v1/integration/slack/configuration/accounts/{account_name}/channels/{channel_name} | Update a Slack integration channel | - +| Method | HTTP request | Description | +| ----------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | --------------------------------------- | +| [**create_slack_integration_channel**](SlackIntegrationAPI.md#create_slack_integration_channel) | **POST** /api/v1/integration/slack/configuration/accounts/{account_name}/channels | Create a Slack integration channel | +| [**get_slack_integration_channel**](SlackIntegrationAPI.md#get_slack_integration_channel) | **GET** /api/v1/integration/slack/configuration/accounts/{account_name}/channels/{channel_name} | Get a Slack integration channel | +| [**get_slack_integration_channels**](SlackIntegrationAPI.md#get_slack_integration_channels) | **GET** /api/v1/integration/slack/configuration/accounts/{account_name}/channels | Get all channels in a Slack integration | +| [**remove_slack_integration_channel**](SlackIntegrationAPI.md#remove_slack_integration_channel) | **DELETE** /api/v1/integration/slack/configuration/accounts/{account_name}/channels/{channel_name} | Remove a Slack integration channel | +| [**update_slack_integration_channel**](SlackIntegrationAPI.md#update_slack_integration_channel) | **PATCH** /api/v1/integration/slack/configuration/accounts/{account_name}/channels/{channel_name} | Update a Slack integration channel | ## create_slack_integration_channel @@ -54,10 +53,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **account_name** | **String** | Your Slack account name. | | -| **body** | [**SlackIntegrationChannel**](SlackIntegrationChannel.md) | Payload describing Slack channel to be created | | +| Name | Type | Description | Notes | +| ---------------- | --------------------------------------------------------- | ---------------------------------------------- | ----- | +| **account_name** | **String** | Your Slack account name. | | +| **body** | [**SlackIntegrationChannel**](SlackIntegrationChannel.md) | Payload describing Slack channel to be created | | ### Return type @@ -72,7 +71,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## get_slack_integration_channel > get_slack_integration_channel(account_name, channel_name) @@ -116,10 +114,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **account_name** | **String** | Your Slack account name. | | -| **channel_name** | **String** | The name of the Slack channel being operated on. | | +| Name | Type | Description | Notes | +| ---------------- | ---------- | ------------------------------------------------ | ----- | +| **account_name** | **String** | Your Slack account name. | | +| **channel_name** | **String** | The name of the Slack channel being operated on. | | ### Return type @@ -134,7 +132,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## get_slack_integration_channels > > get_slack_integration_channels(account_name) @@ -177,9 +174,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **account_name** | **String** | Your Slack account name. | | +| Name | Type | Description | Notes | +| ---------------- | ---------- | ------------------------ | ----- | +| **account_name** | **String** | Your Slack account name. | | ### Return type @@ -194,7 +191,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## remove_slack_integration_channel > remove_slack_integration_channel(account_name, channel_name) @@ -237,10 +233,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **account_name** | **String** | Your Slack account name. | | -| **channel_name** | **String** | The name of the Slack channel being operated on. | | +| Name | Type | Description | Notes | +| ---------------- | ---------- | ------------------------------------------------ | ----- | +| **account_name** | **String** | Your Slack account name. | | +| **channel_name** | **String** | The name of the Slack channel being operated on. | | ### Return type @@ -255,7 +251,6 @@ nil (empty response body) - **Content-Type**: Not defined - **Accept**: application/json - ## update_slack_integration_channel > update_slack_integration_channel(account_name, channel_name, body) @@ -300,11 +295,11 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **account_name** | **String** | Your Slack account name. | | -| **channel_name** | **String** | The name of the Slack channel being operated on. | | -| **body** | [**SlackIntegrationChannel**](SlackIntegrationChannel.md) | Payload describing fields and values to be updated. | | +| Name | Type | Description | Notes | +| ---------------- | --------------------------------------------------------- | --------------------------------------------------- | ----- | +| **account_name** | **String** | Your Slack account name. | | +| **channel_name** | **String** | The name of the Slack channel being operated on. | | +| **body** | [**SlackIntegrationChannel**](SlackIntegrationChannel.md) | Payload describing fields and values to be updated. | | ### Return type @@ -318,4 +313,3 @@ end - **Content-Type**: application/json - **Accept**: application/json - diff --git a/docs/v1/SlackIntegrationChannel.md b/docs/v1/SlackIntegrationChannel.md index 03d74d517155..968d63461c4b 100644 --- a/docs/v1/SlackIntegrationChannel.md +++ b/docs/v1/SlackIntegrationChannel.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **display** | [**SlackIntegrationChannelDisplay**](SlackIntegrationChannelDisplay.md) | | [optional] | -| **name** | **String** | Your channel name. | [optional] | +| Name | Type | Description | Notes | +| ----------- | ----------------------------------------------------------------------- | ------------------ | ---------- | +| **display** | [**SlackIntegrationChannelDisplay**](SlackIntegrationChannelDisplay.md) | | [optional] | +| **name** | **String** | Your channel name. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::SlackIntegrationChannel.new( name: #general ) ``` - diff --git a/docs/v1/SlackIntegrationChannelDisplay.md b/docs/v1/SlackIntegrationChannelDisplay.md index 940904961f47..2c1030a564e4 100644 --- a/docs/v1/SlackIntegrationChannelDisplay.md +++ b/docs/v1/SlackIntegrationChannelDisplay.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **message** | **Boolean** | Show the main body of the alert event. | [optional][default to true] | +| Name | Type | Description | Notes | +| ------------ | ----------- | ---------------------------------------------- | --------------------------- | +| **message** | **Boolean** | Show the main body of the alert event. | [optional][default to true] | | **notified** | **Boolean** | Show the list of @-handles in the alert event. | [optional][default to true] | -| **snapshot** | **Boolean** | Show the alert event's snapshot image. | [optional][default to true] | -| **tags** | **Boolean** | Show the scopes on which the monitor alerted. | [optional][default to true] | +| **snapshot** | **Boolean** | Show the alert event's snapshot image. | [optional][default to true] | +| **tags** | **Boolean** | Show the scopes on which the monitor alerted. | [optional][default to true] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V1::SlackIntegrationChannelDisplay.new( tags: null ) ``` - diff --git a/docs/v1/SnapshotsAPI.md b/docs/v1/SnapshotsAPI.md index 7ec4f2307bf5..4ece29f78880 100644 --- a/docs/v1/SnapshotsAPI.md +++ b/docs/v1/SnapshotsAPI.md @@ -2,14 +2,13 @@ All URIs are relative to *https://api.datadoghq.com* -| Method | HTTP request | Description | -| ------ | ------------ | ----------- | +| Method | HTTP request | Description | +| ------------------------------------------------------------ | ------------------------------ | -------------------- | | [**get_graph_snapshot**](SnapshotsAPI.md#get_graph_snapshot) | **GET** /api/v1/graph/snapshot | Take graph snapshots | - ## get_graph_snapshot -> get_graph_snapshot(start, _end, opts) +> get_graph_snapshot(start, \_end, opts) Take graph snapshots. **Note**: When a snapshot is created, there is some delay before it is available. @@ -41,7 +40,7 @@ end This returns an Array which contains the response data, status code and headers. -> , Integer, Hash)> get_graph_snapshot_with_http_info(start, _end, opts) +> , Integer, Hash)> get_graph_snapshot_with_http_info(start, \_end, opts) ```ruby begin @@ -57,14 +56,14 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **start** | **Integer** | The POSIX timestamp of the start of the query. | | -| **_end** | **Integer** | The POSIX timestamp of the end of the query. | | -| **metric_query** | **String** | The metric query. | [optional] | -| **event_query** | **String** | A query that adds event bands to the graph. | [optional] | -| **graph_def** | **String** | A JSON document defining the graph. `graph_def` can be used instead of `metric_query`. The JSON document uses the [grammar defined here](https://docs.datadoghq.com/graphing/graphing_json/#grammar) and should be formatted to a single line then URL encoded. | [optional] | -| **title** | **String** | A title for the graph. If no title is specified, the graph does not have a title. | [optional] | +| Name | Type | Description | Notes | +| ---------------- | ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **start** | **Integer** | The POSIX timestamp of the start of the query. | | +| **\_end** | **Integer** | The POSIX timestamp of the end of the query. | | +| **metric_query** | **String** | The metric query. | [optional] | +| **event_query** | **String** | A query that adds event bands to the graph. | [optional] | +| **graph_def** | **String** | A JSON document defining the graph. `graph_def` can be used instead of `metric_query`. The JSON document uses the [grammar defined here](https://docs.datadoghq.com/graphing/graphing_json/#grammar) and should be formatted to a single line then URL encoded. | [optional] | +| **title** | **String** | A title for the graph. If no title is specified, the graph does not have a title. | [optional] | ### Return type @@ -78,4 +77,3 @@ end - **Content-Type**: Not defined - **Accept**: application/json - diff --git a/docs/v1/SyntheticsAPI.md b/docs/v1/SyntheticsAPI.md index 24929ec4b944..4617a5cd2be4 100644 --- a/docs/v1/SyntheticsAPI.md +++ b/docs/v1/SyntheticsAPI.md @@ -2,35 +2,34 @@ All URIs are relative to *https://api.datadoghq.com* -| Method | HTTP request | Description | -| ------ | ------------ | ----------- | -| [**create_global_variable**](SyntheticsAPI.md#create_global_variable) | **POST** /api/v1/synthetics/variables | Create a global variable | -| [**create_private_location**](SyntheticsAPI.md#create_private_location) | **POST** /api/v1/synthetics/private-locations | Create a private location | -| [**create_synthetics_api_test**](SyntheticsAPI.md#create_synthetics_api_test) | **POST** /api/v1/synthetics/tests/api | Create an API test | -| [**create_synthetics_browser_test**](SyntheticsAPI.md#create_synthetics_browser_test) | **POST** /api/v1/synthetics/tests/browser | Create a browser test | -| [**delete_global_variable**](SyntheticsAPI.md#delete_global_variable) | **DELETE** /api/v1/synthetics/variables/{variable_id} | Delete a global variable | -| [**delete_private_location**](SyntheticsAPI.md#delete_private_location) | **DELETE** /api/v1/synthetics/private-locations/{location_id} | Delete a private location | -| [**delete_tests**](SyntheticsAPI.md#delete_tests) | **POST** /api/v1/synthetics/tests/delete | Delete tests | -| [**edit_global_variable**](SyntheticsAPI.md#edit_global_variable) | **PUT** /api/v1/synthetics/variables/{variable_id} | Edit a global variable | -| [**get_api_test**](SyntheticsAPI.md#get_api_test) | **GET** /api/v1/synthetics/tests/api/{public_id} | Get an API test | -| [**get_api_test_latest_results**](SyntheticsAPI.md#get_api_test_latest_results) | **GET** /api/v1/synthetics/tests/{public_id}/results | Get an API test's latest results summaries | -| [**get_api_test_result**](SyntheticsAPI.md#get_api_test_result) | **GET** /api/v1/synthetics/tests/{public_id}/results/{result_id} | Get an API test result | -| [**get_browser_test**](SyntheticsAPI.md#get_browser_test) | **GET** /api/v1/synthetics/tests/browser/{public_id} | Get a browser test | -| [**get_browser_test_latest_results**](SyntheticsAPI.md#get_browser_test_latest_results) | **GET** /api/v1/synthetics/tests/browser/{public_id}/results | Get a browser test's latest results summaries | -| [**get_browser_test_result**](SyntheticsAPI.md#get_browser_test_result) | **GET** /api/v1/synthetics/tests/browser/{public_id}/results/{result_id} | Get a browser test result | -| [**get_global_variable**](SyntheticsAPI.md#get_global_variable) | **GET** /api/v1/synthetics/variables/{variable_id} | Get a global variable | -| [**get_private_location**](SyntheticsAPI.md#get_private_location) | **GET** /api/v1/synthetics/private-locations/{location_id} | Get a private location | -| [**get_synthetics_ci_batch**](SyntheticsAPI.md#get_synthetics_ci_batch) | **GET** /api/v1/synthetics/ci/batch/{batch_id} | Get details of batch | -| [**get_test**](SyntheticsAPI.md#get_test) | **GET** /api/v1/synthetics/tests/{public_id} | Get a test configuration | -| [**list_global_variables**](SyntheticsAPI.md#list_global_variables) | **GET** /api/v1/synthetics/variables | Get all global variables | -| [**list_locations**](SyntheticsAPI.md#list_locations) | **GET** /api/v1/synthetics/locations | Get all locations (public and private) | -| [**list_tests**](SyntheticsAPI.md#list_tests) | **GET** /api/v1/synthetics/tests | Get the list of all tests | -| [**trigger_ci_tests**](SyntheticsAPI.md#trigger_ci_tests) | **POST** /api/v1/synthetics/tests/trigger/ci | Trigger tests from CI/CD pipelines | -| [**update_api_test**](SyntheticsAPI.md#update_api_test) | **PUT** /api/v1/synthetics/tests/api/{public_id} | Edit an API test | -| [**update_browser_test**](SyntheticsAPI.md#update_browser_test) | **PUT** /api/v1/synthetics/tests/browser/{public_id} | Edit a browser test | -| [**update_private_location**](SyntheticsAPI.md#update_private_location) | **PUT** /api/v1/synthetics/private-locations/{location_id} | Edit a private location | -| [**update_test_pause_status**](SyntheticsAPI.md#update_test_pause_status) | **PUT** /api/v1/synthetics/tests/{public_id}/status | Pause or start a test | - +| Method | HTTP request | Description | +| --------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | ------------------------------------------------- | +| [**create_global_variable**](SyntheticsAPI.md#create_global_variable) | **POST** /api/v1/synthetics/variables | Create a global variable | +| [**create_private_location**](SyntheticsAPI.md#create_private_location) | **POST** /api/v1/synthetics/private-locations | Create a private location | +| [**create_synthetics_api_test**](SyntheticsAPI.md#create_synthetics_api_test) | **POST** /api/v1/synthetics/tests/api | Create an API test | +| [**create_synthetics_browser_test**](SyntheticsAPI.md#create_synthetics_browser_test) | **POST** /api/v1/synthetics/tests/browser | Create a browser test | +| [**delete_global_variable**](SyntheticsAPI.md#delete_global_variable) | **DELETE** /api/v1/synthetics/variables/{variable_id} | Delete a global variable | +| [**delete_private_location**](SyntheticsAPI.md#delete_private_location) | **DELETE** /api/v1/synthetics/private-locations/{location_id} | Delete a private location | +| [**delete_tests**](SyntheticsAPI.md#delete_tests) | **POST** /api/v1/synthetics/tests/delete | Delete tests | +| [**edit_global_variable**](SyntheticsAPI.md#edit_global_variable) | **PUT** /api/v1/synthetics/variables/{variable_id} | Edit a global variable | +| [**get_api_test**](SyntheticsAPI.md#get_api_test) | **GET** /api/v1/synthetics/tests/api/{public_id} | Get an API test | +| [**get_api_test_latest_results**](SyntheticsAPI.md#get_api_test_latest_results) | **GET** /api/v1/synthetics/tests/{public_id}/results | Get an API test's latest results summaries | +| [**get_api_test_result**](SyntheticsAPI.md#get_api_test_result) | **GET** /api/v1/synthetics/tests/{public_id}/results/{result_id} | Get an API test result | +| [**get_browser_test**](SyntheticsAPI.md#get_browser_test) | **GET** /api/v1/synthetics/tests/browser/{public_id} | Get a browser test | +| [**get_browser_test_latest_results**](SyntheticsAPI.md#get_browser_test_latest_results) | **GET** /api/v1/synthetics/tests/browser/{public_id}/results | Get a browser test's latest results summaries | +| [**get_browser_test_result**](SyntheticsAPI.md#get_browser_test_result) | **GET** /api/v1/synthetics/tests/browser/{public_id}/results/{result_id} | Get a browser test result | +| [**get_global_variable**](SyntheticsAPI.md#get_global_variable) | **GET** /api/v1/synthetics/variables/{variable_id} | Get a global variable | +| [**get_private_location**](SyntheticsAPI.md#get_private_location) | **GET** /api/v1/synthetics/private-locations/{location_id} | Get a private location | +| [**get_synthetics_ci_batch**](SyntheticsAPI.md#get_synthetics_ci_batch) | **GET** /api/v1/synthetics/ci/batch/{batch_id} | Get details of batch | +| [**get_test**](SyntheticsAPI.md#get_test) | **GET** /api/v1/synthetics/tests/{public_id} | Get a test configuration | +| [**list_global_variables**](SyntheticsAPI.md#list_global_variables) | **GET** /api/v1/synthetics/variables | Get all global variables | +| [**list_locations**](SyntheticsAPI.md#list_locations) | **GET** /api/v1/synthetics/locations | Get all locations (public and private) | +| [**list_tests**](SyntheticsAPI.md#list_tests) | **GET** /api/v1/synthetics/tests | Get the list of all tests | +| [**trigger_ci_tests**](SyntheticsAPI.md#trigger_ci_tests) | **POST** /api/v1/synthetics/tests/trigger/ci | Trigger tests from CI/CD pipelines | +| [**update_api_test**](SyntheticsAPI.md#update_api_test) | **PUT** /api/v1/synthetics/tests/api/{public_id} | Edit an API test | +| [**update_browser_test**](SyntheticsAPI.md#update_browser_test) | **PUT** /api/v1/synthetics/tests/browser/{public_id} | Edit a browser test | +| [**update_private_location**](SyntheticsAPI.md#update_private_location) | **PUT** /api/v1/synthetics/private-locations/{location_id} | Edit a private location | +| [**update_test_pause_status**](SyntheticsAPI.md#update_test_pause_status) | **PUT** /api/v1/synthetics/tests/{public_id}/status | Pause or start a test | ## create_global_variable @@ -74,9 +73,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**SyntheticsGlobalVariable**](SyntheticsGlobalVariable.md) | Details of the global variable to create. | | +| Name | Type | Description | Notes | +| -------- | ----------------------------------------------------------- | ----------------------------------------- | ----- | +| **body** | [**SyntheticsGlobalVariable**](SyntheticsGlobalVariable.md) | Details of the global variable to create. | | ### Return type @@ -91,7 +90,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## create_private_location > create_private_location(body) @@ -134,9 +132,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**SyntheticsPrivateLocation**](SyntheticsPrivateLocation.md) | Details of the private location to create. | | +| Name | Type | Description | Notes | +| -------- | ------------------------------------------------------------- | ------------------------------------------ | ----- | +| **body** | [**SyntheticsPrivateLocation**](SyntheticsPrivateLocation.md) | Details of the private location to create. | | ### Return type @@ -151,7 +149,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## create_synthetics_api_test > create_synthetics_api_test(body) @@ -194,9 +191,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**SyntheticsAPITest**](SyntheticsAPITest.md) | Details of the test to create. | | +| Name | Type | Description | Notes | +| -------- | --------------------------------------------- | ------------------------------ | ----- | +| **body** | [**SyntheticsAPITest**](SyntheticsAPITest.md) | Details of the test to create. | | ### Return type @@ -211,7 +208,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## create_synthetics_browser_test > create_synthetics_browser_test(body) @@ -254,9 +250,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**SyntheticsBrowserTest**](SyntheticsBrowserTest.md) | Details of the test to create. | | +| Name | Type | Description | Notes | +| -------- | ----------------------------------------------------- | ------------------------------ | ----- | +| **body** | [**SyntheticsBrowserTest**](SyntheticsBrowserTest.md) | Details of the test to create. | | ### Return type @@ -271,7 +267,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## delete_global_variable > delete_global_variable(variable_id) @@ -313,9 +308,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **variable_id** | **String** | The ID of the global variable. | | +| Name | Type | Description | Notes | +| --------------- | ---------- | ------------------------------ | ----- | +| **variable_id** | **String** | The ID of the global variable. | | ### Return type @@ -330,7 +325,6 @@ nil (empty response body) - **Content-Type**: Not defined - **Accept**: application/json - ## delete_private_location > delete_private_location(location_id) @@ -372,9 +366,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **location_id** | **String** | The ID of the private location. | | +| Name | Type | Description | Notes | +| --------------- | ---------- | ------------------------------- | ----- | +| **location_id** | **String** | The ID of the private location. | | ### Return type @@ -389,7 +383,6 @@ nil (empty response body) - **Content-Type**: Not defined - **Accept**: application/json - ## delete_tests > delete_tests(body) @@ -432,9 +425,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**SyntheticsDeleteTestsPayload**](SyntheticsDeleteTestsPayload.md) | Public ID list of the Synthetic tests to be deleted. | | +| Name | Type | Description | Notes | +| -------- | ------------------------------------------------------------------- | ---------------------------------------------------- | ----- | +| **body** | [**SyntheticsDeleteTestsPayload**](SyntheticsDeleteTestsPayload.md) | Public ID list of the Synthetic tests to be deleted. | | ### Return type @@ -449,7 +442,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## edit_global_variable > edit_global_variable(variable_id, body) @@ -493,10 +485,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **variable_id** | **String** | The ID of the global variable. | | -| **body** | [**SyntheticsGlobalVariable**](SyntheticsGlobalVariable.md) | Details of the global variable to update. | | +| Name | Type | Description | Notes | +| --------------- | ----------------------------------------------------------- | ----------------------------------------- | ----- | +| **variable_id** | **String** | The ID of the global variable. | | +| **body** | [**SyntheticsGlobalVariable**](SyntheticsGlobalVariable.md) | Details of the global variable to update. | | ### Return type @@ -511,7 +503,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## get_api_test > get_api_test(public_id) @@ -555,9 +546,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **public_id** | **String** | The public ID of the test to get details from. | | +| Name | Type | Description | Notes | +| ------------- | ---------- | ---------------------------------------------- | ----- | +| **public_id** | **String** | The public ID of the test to get details from. | | ### Return type @@ -572,7 +563,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## get_api_test_latest_results > get_api_test_latest_results(public_id, opts) @@ -620,12 +610,12 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **public_id** | **String** | The public ID of the test for which to search results for. | | -| **from_ts** | **Integer** | Timestamp in milliseconds from which to start querying results. | [optional] | -| **to_ts** | **Integer** | Timestamp in milliseconds up to which to query results. | [optional] | -| **probe_dc** | **Array<String>** | Locations for which to query results. | [optional] | +| Name | Type | Description | Notes | +| ------------- | ----------------------- | --------------------------------------------------------------- | ---------- | +| **public_id** | **String** | The public ID of the test for which to search results for. | | +| **from_ts** | **Integer** | Timestamp in milliseconds from which to start querying results. | [optional] | +| **to_ts** | **Integer** | Timestamp in milliseconds up to which to query results. | [optional] | +| **probe_dc** | **Array<String>** | Locations for which to query results. | [optional] | ### Return type @@ -640,7 +630,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## get_api_test_result > get_api_test_result(public_id, result_id) @@ -684,10 +673,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **public_id** | **String** | The public ID of the API test to which the target result belongs. | | -| **result_id** | **String** | The ID of the result to get. | | +| Name | Type | Description | Notes | +| ------------- | ---------- | ----------------------------------------------------------------- | ----- | +| **public_id** | **String** | The public ID of the API test to which the target result belongs. | | +| **result_id** | **String** | The ID of the result to get. | | ### Return type @@ -702,7 +691,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## get_browser_test > get_browser_test(public_id) @@ -746,9 +734,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **public_id** | **String** | The public ID of the test to get details from. | | +| Name | Type | Description | Notes | +| ------------- | ---------- | ---------------------------------------------- | ----- | +| **public_id** | **String** | The public ID of the test to get details from. | | ### Return type @@ -763,7 +751,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## get_browser_test_latest_results > get_browser_test_latest_results(public_id, opts) @@ -811,12 +798,12 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **public_id** | **String** | The public ID of the browser test for which to search results for. | | -| **from_ts** | **Integer** | Timestamp in milliseconds from which to start querying results. | [optional] | -| **to_ts** | **Integer** | Timestamp in milliseconds up to which to query results. | [optional] | -| **probe_dc** | **Array<String>** | Locations for which to query results. | [optional] | +| Name | Type | Description | Notes | +| ------------- | ----------------------- | ------------------------------------------------------------------ | ---------- | +| **public_id** | **String** | The public ID of the browser test for which to search results for. | | +| **from_ts** | **Integer** | Timestamp in milliseconds from which to start querying results. | [optional] | +| **to_ts** | **Integer** | Timestamp in milliseconds up to which to query results. | [optional] | +| **probe_dc** | **Array<String>** | Locations for which to query results. | [optional] | ### Return type @@ -831,7 +818,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## get_browser_test_result > get_browser_test_result(public_id, result_id) @@ -875,10 +861,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **public_id** | **String** | The public ID of the browser test to which the target result belongs. | | -| **result_id** | **String** | The ID of the result to get. | | +| Name | Type | Description | Notes | +| ------------- | ---------- | --------------------------------------------------------------------- | ----- | +| **public_id** | **String** | The public ID of the browser test to which the target result belongs. | | +| **result_id** | **String** | The ID of the result to get. | | ### Return type @@ -893,7 +879,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## get_global_variable > get_global_variable(variable_id) @@ -936,9 +921,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **variable_id** | **String** | The ID of the global variable. | | +| Name | Type | Description | Notes | +| --------------- | ---------- | ------------------------------ | ----- | +| **variable_id** | **String** | The ID of the global variable. | | ### Return type @@ -953,7 +938,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## get_private_location > get_private_location(location_id) @@ -996,9 +980,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **location_id** | **String** | The ID of the private location. | | +| Name | Type | Description | Notes | +| --------------- | ---------- | ------------------------------- | ----- | +| **location_id** | **String** | The ID of the private location. | | ### Return type @@ -1013,7 +997,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## get_synthetics_ci_batch > get_synthetics_ci_batch(batch_id) @@ -1056,9 +1039,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **batch_id** | **String** | The ID of the batch. | | +| Name | Type | Description | Notes | +| ------------ | ---------- | -------------------- | ----- | +| **batch_id** | **String** | The ID of the batch. | | ### Return type @@ -1073,7 +1056,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## get_test > get_test(public_id) @@ -1116,9 +1098,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **public_id** | **String** | The public ID of the test to get details from. | | +| Name | Type | Description | Notes | +| ------------- | ---------- | ---------------------------------------------- | ----- | +| **public_id** | **String** | The public ID of the test to get details from. | | ### Return type @@ -1133,7 +1115,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## list_global_variables > list_global_variables @@ -1190,7 +1171,6 @@ This endpoint does not need any parameter. - **Content-Type**: Not defined - **Accept**: application/json - ## list_locations > list_locations @@ -1248,7 +1228,6 @@ This endpoint does not need any parameter. - **Content-Type**: Not defined - **Accept**: application/json - ## list_tests > list_tests @@ -1305,7 +1284,6 @@ This endpoint does not need any parameter. - **Content-Type**: Not defined - **Accept**: application/json - ## trigger_ci_tests > trigger_ci_tests(body) @@ -1348,9 +1326,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**SyntheticsCITestBody**](SyntheticsCITestBody.md) | Details of the test to trigger. | | +| Name | Type | Description | Notes | +| -------- | --------------------------------------------------- | ------------------------------- | ----- | +| **body** | [**SyntheticsCITestBody**](SyntheticsCITestBody.md) | Details of the test to trigger. | | ### Return type @@ -1365,7 +1343,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## update_api_test > update_api_test(public_id, body) @@ -1409,10 +1386,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **public_id** | **String** | The public ID of the test to get details from. | | -| **body** | [**SyntheticsAPITest**](SyntheticsAPITest.md) | New test details to be saved. | | +| Name | Type | Description | Notes | +| ------------- | --------------------------------------------- | ---------------------------------------------- | ----- | +| **public_id** | **String** | The public ID of the test to get details from. | | +| **body** | [**SyntheticsAPITest**](SyntheticsAPITest.md) | New test details to be saved. | | ### Return type @@ -1427,7 +1404,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## update_browser_test > update_browser_test(public_id, body) @@ -1471,10 +1447,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **public_id** | **String** | The public ID of the test to get details from. | | -| **body** | [**SyntheticsBrowserTest**](SyntheticsBrowserTest.md) | New test details to be saved. | | +| Name | Type | Description | Notes | +| ------------- | ----------------------------------------------------- | ---------------------------------------------- | ----- | +| **public_id** | **String** | The public ID of the test to get details from. | | +| **body** | [**SyntheticsBrowserTest**](SyntheticsBrowserTest.md) | New test details to be saved. | | ### Return type @@ -1489,7 +1465,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## update_private_location > update_private_location(location_id, body) @@ -1533,10 +1508,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **location_id** | **String** | The ID of the private location. | | -| **body** | [**SyntheticsPrivateLocation**](SyntheticsPrivateLocation.md) | Details of the private location to be updated. | | +| Name | Type | Description | Notes | +| --------------- | ------------------------------------------------------------- | ---------------------------------------------- | ----- | +| **location_id** | **String** | The ID of the private location. | | +| **body** | [**SyntheticsPrivateLocation**](SyntheticsPrivateLocation.md) | Details of the private location to be updated. | | ### Return type @@ -1551,7 +1526,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## update_test_pause_status > Boolean update_test_pause_status(public_id, body) @@ -1595,10 +1569,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **public_id** | **String** | The public ID of the Synthetic test to update. | | -| **body** | [**SyntheticsUpdateTestPauseStatusPayload**](SyntheticsUpdateTestPauseStatusPayload.md) | Status to set the given Synthetic test to. | | +| Name | Type | Description | Notes | +| ------------- | --------------------------------------------------------------------------------------- | ---------------------------------------------- | ----- | +| **public_id** | **String** | The public ID of the Synthetic test to update. | | +| **body** | [**SyntheticsUpdateTestPauseStatusPayload**](SyntheticsUpdateTestPauseStatusPayload.md) | Status to set the given Synthetic test to. | | ### Return type @@ -1612,4 +1586,3 @@ end - **Content-Type**: application/json - **Accept**: application/json - diff --git a/docs/v1/SyntheticsAPIStep.md b/docs/v1/SyntheticsAPIStep.md index b4157ae50436..4a4eefcaa77e 100644 --- a/docs/v1/SyntheticsAPIStep.md +++ b/docs/v1/SyntheticsAPIStep.md @@ -2,15 +2,15 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **allow_failure** | **Boolean** | Determines whether or not to continue with test if this step fails. | [optional] | -| **assertions** | [**Array<SyntheticsAssertion>**](SyntheticsAssertion.md) | Array of assertions used for the test. | [optional] | -| **extracted_values** | [**Array<SyntheticsParsingOptions>**](SyntheticsParsingOptions.md) | Array of values to parse and save as variables from the response. | [optional] | -| **is_critical** | **Boolean** | Determines whether or not to consider the entire test as failed if this step fails. Can be used only if `allowFailure` is `true`. | [optional] | -| **name** | **String** | The name of the step. | [optional] | -| **request** | [**SyntheticsTestRequest**](SyntheticsTestRequest.md) | | [optional] | -| **subtype** | [**SyntheticsAPIStepSubtype**](SyntheticsAPIStepSubtype.md) | | [optional] | +| Name | Type | Description | Notes | +| -------------------- | ------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **allow_failure** | **Boolean** | Determines whether or not to continue with test if this step fails. | [optional] | +| **assertions** | [**Array<SyntheticsAssertion>**](SyntheticsAssertion.md) | Array of assertions used for the test. | [optional] | +| **extracted_values** | [**Array<SyntheticsParsingOptions>**](SyntheticsParsingOptions.md) | Array of values to parse and save as variables from the response. | [optional] | +| **is_critical** | **Boolean** | Determines whether or not to consider the entire test as failed if this step fails. Can be used only if `allowFailure` is `true`. | [optional] | +| **name** | **String** | The name of the step. | [optional] | +| **request** | [**SyntheticsTestRequest**](SyntheticsTestRequest.md) | | [optional] | +| **subtype** | [**SyntheticsAPIStepSubtype**](SyntheticsAPIStepSubtype.md) | | [optional] | ## Example @@ -27,4 +27,3 @@ instance = DatadogAPIClient::V1::SyntheticsAPIStep.new( subtype: null ) ``` - diff --git a/docs/v1/SyntheticsAPIStepSubtype.md b/docs/v1/SyntheticsAPIStepSubtype.md index 01f7d256e57e..fee65ad67b24 100644 --- a/docs/v1/SyntheticsAPIStepSubtype.md +++ b/docs/v1/SyntheticsAPIStepSubtype.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::SyntheticsAPIStepSubtype.new() ``` - diff --git a/docs/v1/SyntheticsAPITest.md b/docs/v1/SyntheticsAPITest.md index f8fe04ce90c7..b54c90530d3f 100644 --- a/docs/v1/SyntheticsAPITest.md +++ b/docs/v1/SyntheticsAPITest.md @@ -2,19 +2,19 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **config** | [**SyntheticsAPITestConfig**](SyntheticsAPITestConfig.md) | | [optional] | -| **locations** | **Array<String>** | Array of locations used to run the test. | [optional] | -| **message** | **String** | Notification message associated with the test. | [optional] | -| **monitor_id** | **Integer** | The associated monitor ID. | [optional][readonly] | -| **name** | **String** | Name of the test. | [optional] | -| **options** | [**SyntheticsTestOptions**](SyntheticsTestOptions.md) | | [optional] | -| **public_id** | **String** | The public ID for the test. | [optional][readonly] | -| **status** | [**SyntheticsTestPauseStatus**](SyntheticsTestPauseStatus.md) | | [optional] | -| **subtype** | [**SyntheticsTestDetailsSubType**](SyntheticsTestDetailsSubType.md) | | [optional] | -| **tags** | **Array<String>** | Array of tags attached to the test. | [optional] | -| **type** | [**SyntheticsAPITestType**](SyntheticsAPITestType.md) | | [optional][default to 'api'] | +| Name | Type | Description | Notes | +| -------------- | ------------------------------------------------------------------- | ---------------------------------------------- | ------------------------------------ | +| **config** | [**SyntheticsAPITestConfig**](SyntheticsAPITestConfig.md) | | [optional] | +| **locations** | **Array<String>** | Array of locations used to run the test. | [optional] | +| **message** | **String** | Notification message associated with the test. | [optional] | +| **monitor_id** | **Integer** | The associated monitor ID. | [optional][readonly] | +| **name** | **String** | Name of the test. | [optional] | +| **options** | [**SyntheticsTestOptions**](SyntheticsTestOptions.md) | | [optional] | +| **public_id** | **String** | The public ID for the test. | [optional][readonly] | +| **status** | [**SyntheticsTestPauseStatus**](SyntheticsTestPauseStatus.md) | | [optional] | +| **subtype** | [**SyntheticsTestDetailsSubType**](SyntheticsTestDetailsSubType.md) | | [optional] | +| **tags** | **Array<String>** | Array of tags attached to the test. | [optional] | +| **type** | [**SyntheticsAPITestType**](SyntheticsAPITestType.md) | | [optional][default to 'api'] | ## Example @@ -35,4 +35,3 @@ instance = DatadogAPIClient::V1::SyntheticsAPITest.new( type: null ) ``` - diff --git a/docs/v1/SyntheticsAPITestConfig.md b/docs/v1/SyntheticsAPITestConfig.md index f019532af83a..f2ca1d173fc6 100644 --- a/docs/v1/SyntheticsAPITestConfig.md +++ b/docs/v1/SyntheticsAPITestConfig.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **assertions** | [**Array<SyntheticsAssertion>**](SyntheticsAssertion.md) | Array of assertions used for the test. | [optional] | -| **config_variables** | [**Array<SyntheticsConfigVariable>**](SyntheticsConfigVariable.md) | Array of variables used for the test. | [optional] | -| **request** | [**SyntheticsTestRequest**](SyntheticsTestRequest.md) | | [optional] | -| **steps** | [**Array<SyntheticsAPIStep>**](SyntheticsAPIStep.md) | When the test subtype is `multi`, the steps of the test. | [optional] | +| Name | Type | Description | Notes | +| -------------------- | ------------------------------------------------------------------------ | ------------------------------------------------------------------ | ---------- | +| **assertions** | [**Array<SyntheticsAssertion>**](SyntheticsAssertion.md) | Array of assertions used for the test. | [optional] | +| **config_variables** | [**Array<SyntheticsConfigVariable>**](SyntheticsConfigVariable.md) | Array of variables used for the test. | [optional] | +| **request** | [**SyntheticsTestRequest**](SyntheticsTestRequest.md) | | [optional] | +| **steps** | [**Array<SyntheticsAPIStep>**](SyntheticsAPIStep.md) | When the test subtype is `multi`, the steps of the test. | [optional] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V1::SyntheticsAPITestConfig.new( steps: null ) ``` - diff --git a/docs/v1/SyntheticsAPITestResultData.md b/docs/v1/SyntheticsAPITestResultData.md index 4199394c416d..422fcbc66987 100644 --- a/docs/v1/SyntheticsAPITestResultData.md +++ b/docs/v1/SyntheticsAPITestResultData.md @@ -2,18 +2,18 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **cert** | [**SyntheticsSSLCertificate**](SyntheticsSSLCertificate.md) | | [optional] | -| **error_code** | [**SyntheticsErrorCode**](SyntheticsErrorCode.md) | | [optional] | -| **error_message** | **String** | The API test error message. | [optional] | -| **event_type** | [**SyntheticsTestProcessStatus**](SyntheticsTestProcessStatus.md) | | [optional] | -| **http_status_code** | **Integer** | The API test HTTP status code. | [optional] | -| **request_headers** | **Hash<String, Object>** | Request header object used for the API test. | [optional] | -| **response_body** | **String** | Response body returned for the API test. | [optional] | -| **response_headers** | **Hash<String, Object>** | Response headers returned for the API test. | [optional] | -| **response_size** | **Integer** | Global size in byte of the API test response. | [optional] | -| **timings** | [**SyntheticsTiming**](SyntheticsTiming.md) | | [optional] | +| Name | Type | Description | Notes | +| -------------------- | ----------------------------------------------------------------- | --------------------------------------------- | ---------- | +| **cert** | [**SyntheticsSSLCertificate**](SyntheticsSSLCertificate.md) | | [optional] | +| **error_code** | [**SyntheticsErrorCode**](SyntheticsErrorCode.md) | | [optional] | +| **error_message** | **String** | The API test error message. | [optional] | +| **event_type** | [**SyntheticsTestProcessStatus**](SyntheticsTestProcessStatus.md) | | [optional] | +| **http_status_code** | **Integer** | The API test HTTP status code. | [optional] | +| **request_headers** | **Hash<String, Object>** | Request header object used for the API test. | [optional] | +| **response_body** | **String** | Response body returned for the API test. | [optional] | +| **response_headers** | **Hash<String, Object>** | Response headers returned for the API test. | [optional] | +| **response_size** | **Integer** | Global size in byte of the API test response. | [optional] | +| **timings** | [**SyntheticsTiming**](SyntheticsTiming.md) | | [optional] | ## Example @@ -33,4 +33,3 @@ instance = DatadogAPIClient::V1::SyntheticsAPITestResultData.new( timings: null ) ``` - diff --git a/docs/v1/SyntheticsAPITestResultFull.md b/docs/v1/SyntheticsAPITestResultFull.md index adaa469e14b7..294096756275 100644 --- a/docs/v1/SyntheticsAPITestResultFull.md +++ b/docs/v1/SyntheticsAPITestResultFull.md @@ -2,15 +2,15 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **check** | [**SyntheticsAPITestResultFullCheck**](SyntheticsAPITestResultFullCheck.md) | | [optional] | -| **check_time** | **Float** | When the API test was conducted. | [optional] | -| **check_version** | **Integer** | Version of the API test used. | [optional] | -| **probe_dc** | **String** | Locations for which to query the API test results. | [optional] | -| **result** | [**SyntheticsAPITestResultData**](SyntheticsAPITestResultData.md) | | [optional] | -| **result_id** | **String** | ID of the API test result. | [optional] | -| **status** | [**SyntheticsTestMonitorStatus**](SyntheticsTestMonitorStatus.md) | | [optional] | +| Name | Type | Description | Notes | +| ----------------- | --------------------------------------------------------------------------- | -------------------------------------------------- | ---------- | +| **check** | [**SyntheticsAPITestResultFullCheck**](SyntheticsAPITestResultFullCheck.md) | | [optional] | +| **check_time** | **Float** | When the API test was conducted. | [optional] | +| **check_version** | **Integer** | Version of the API test used. | [optional] | +| **probe_dc** | **String** | Locations for which to query the API test results. | [optional] | +| **result** | [**SyntheticsAPITestResultData**](SyntheticsAPITestResultData.md) | | [optional] | +| **result_id** | **String** | ID of the API test result. | [optional] | +| **status** | [**SyntheticsTestMonitorStatus**](SyntheticsTestMonitorStatus.md) | | [optional] | ## Example @@ -27,4 +27,3 @@ instance = DatadogAPIClient::V1::SyntheticsAPITestResultFull.new( status: null ) ``` - diff --git a/docs/v1/SyntheticsAPITestResultFullCheck.md b/docs/v1/SyntheticsAPITestResultFullCheck.md index 4629f8843edb..829a1bc3c83c 100644 --- a/docs/v1/SyntheticsAPITestResultFullCheck.md +++ b/docs/v1/SyntheticsAPITestResultFullCheck.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **config** | [**SyntheticsTestConfig**](SyntheticsTestConfig.md) | | | +| Name | Type | Description | Notes | +| ---------- | --------------------------------------------------- | ----------- | ----- | +| **config** | [**SyntheticsTestConfig**](SyntheticsTestConfig.md) | | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::SyntheticsAPITestResultFullCheck.new( config: null ) ``` - diff --git a/docs/v1/SyntheticsAPITestResultShort.md b/docs/v1/SyntheticsAPITestResultShort.md index 7c5a3c7b1c2c..ddd9f7fad9d6 100644 --- a/docs/v1/SyntheticsAPITestResultShort.md +++ b/docs/v1/SyntheticsAPITestResultShort.md @@ -2,13 +2,13 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **check_time** | **Float** | Last time the API test was performed. | [optional] | -| **probe_dc** | **String** | Location from which the API test was performed. | [optional] | -| **result** | [**SyntheticsAPITestResultShortResult**](SyntheticsAPITestResultShortResult.md) | | [optional] | -| **result_id** | **String** | ID of the API test result. | [optional] | -| **status** | [**SyntheticsTestMonitorStatus**](SyntheticsTestMonitorStatus.md) | | [optional] | +| Name | Type | Description | Notes | +| -------------- | ------------------------------------------------------------------------------- | ----------------------------------------------- | ---------- | +| **check_time** | **Float** | Last time the API test was performed. | [optional] | +| **probe_dc** | **String** | Location from which the API test was performed. | [optional] | +| **result** | [**SyntheticsAPITestResultShortResult**](SyntheticsAPITestResultShortResult.md) | | [optional] | +| **result_id** | **String** | ID of the API test result. | [optional] | +| **status** | [**SyntheticsTestMonitorStatus**](SyntheticsTestMonitorStatus.md) | | [optional] | ## Example @@ -23,4 +23,3 @@ instance = DatadogAPIClient::V1::SyntheticsAPITestResultShort.new( status: null ) ``` - diff --git a/docs/v1/SyntheticsAPITestResultShortResult.md b/docs/v1/SyntheticsAPITestResultShortResult.md index 36a33f03942e..2f977d6ff959 100644 --- a/docs/v1/SyntheticsAPITestResultShortResult.md +++ b/docs/v1/SyntheticsAPITestResultShortResult.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **passed** | **Boolean** | Describes if the test run has passed or failed. | [optional] | -| **timings** | [**SyntheticsTiming**](SyntheticsTiming.md) | | [optional] | +| Name | Type | Description | Notes | +| ----------- | ------------------------------------------- | ----------------------------------------------- | ---------- | +| **passed** | **Boolean** | Describes if the test run has passed or failed. | [optional] | +| **timings** | [**SyntheticsTiming**](SyntheticsTiming.md) | | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::SyntheticsAPITestResultShortResult.new( timings: null ) ``` - diff --git a/docs/v1/SyntheticsAPITestType.md b/docs/v1/SyntheticsAPITestType.md index fbe042d16566..38e353a8a4b7 100644 --- a/docs/v1/SyntheticsAPITestType.md +++ b/docs/v1/SyntheticsAPITestType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::SyntheticsAPITestType.new() ``` - diff --git a/docs/v1/SyntheticsAssertion.md b/docs/v1/SyntheticsAssertion.md index 26b494a9cea1..28e221e30266 100644 --- a/docs/v1/SyntheticsAssertion.md +++ b/docs/v1/SyntheticsAssertion.md @@ -37,8 +37,8 @@ DatadogAPIClient::V1::SyntheticsAssertion.build(data_that_doesnt_match) #### Parameters -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| -------- | --------- | -------------------------------------------------- | | **data** | **Mixed** | data to be matched against the list of oneOf items | #### Return type @@ -46,4 +46,3 @@ DatadogAPIClient::V1::SyntheticsAssertion.build(data_that_doesnt_match) - `SyntheticsAssertionJSONPathTarget` - `SyntheticsAssertionTarget` - `nil` (if no type matches) - diff --git a/docs/v1/SyntheticsAssertionJSONPathOperator.md b/docs/v1/SyntheticsAssertionJSONPathOperator.md index ec5972dae364..06b850995132 100644 --- a/docs/v1/SyntheticsAssertionJSONPathOperator.md +++ b/docs/v1/SyntheticsAssertionJSONPathOperator.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::SyntheticsAssertionJSONPathOperator.new() ``` - diff --git a/docs/v1/SyntheticsAssertionJSONPathTarget.md b/docs/v1/SyntheticsAssertionJSONPathTarget.md index e691a77009ca..5d96ea1993dd 100644 --- a/docs/v1/SyntheticsAssertionJSONPathTarget.md +++ b/docs/v1/SyntheticsAssertionJSONPathTarget.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **operator** | [**SyntheticsAssertionJSONPathOperator**](SyntheticsAssertionJSONPathOperator.md) | | | -| **property** | **String** | The associated assertion property. | [optional] | -| **target** | [**SyntheticsAssertionJSONPathTargetTarget**](SyntheticsAssertionJSONPathTargetTarget.md) | | [optional] | -| **type** | [**SyntheticsAssertionType**](SyntheticsAssertionType.md) | | | +| Name | Type | Description | Notes | +| ------------ | ----------------------------------------------------------------------------------------- | ---------------------------------- | ---------- | +| **operator** | [**SyntheticsAssertionJSONPathOperator**](SyntheticsAssertionJSONPathOperator.md) | | | +| **property** | **String** | The associated assertion property. | [optional] | +| **target** | [**SyntheticsAssertionJSONPathTargetTarget**](SyntheticsAssertionJSONPathTargetTarget.md) | | [optional] | +| **type** | [**SyntheticsAssertionType**](SyntheticsAssertionType.md) | | | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V1::SyntheticsAssertionJSONPathTarget.new( type: null ) ``` - diff --git a/docs/v1/SyntheticsAssertionJSONPathTargetTarget.md b/docs/v1/SyntheticsAssertionJSONPathTargetTarget.md index f8be07cb0817..f7b4da86fb3b 100644 --- a/docs/v1/SyntheticsAssertionJSONPathTargetTarget.md +++ b/docs/v1/SyntheticsAssertionJSONPathTargetTarget.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **json_path** | **String** | The JSON path to assert. | [optional] | -| **operator** | **String** | The specific operator to use on the path. | [optional] | -| **target_value** | **Object** | The path target value to compare to. | [optional] | +| Name | Type | Description | Notes | +| ---------------- | ---------- | ----------------------------------------- | ---------- | +| **json_path** | **String** | The JSON path to assert. | [optional] | +| **operator** | **String** | The specific operator to use on the path. | [optional] | +| **target_value** | **Object** | The path target value to compare to. | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::SyntheticsAssertionJSONPathTargetTarget.new( target_value: null ) ``` - diff --git a/docs/v1/SyntheticsAssertionOperator.md b/docs/v1/SyntheticsAssertionOperator.md index dc0db24d75e0..154eeb3b7167 100644 --- a/docs/v1/SyntheticsAssertionOperator.md +++ b/docs/v1/SyntheticsAssertionOperator.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::SyntheticsAssertionOperator.new() ``` - diff --git a/docs/v1/SyntheticsAssertionTarget.md b/docs/v1/SyntheticsAssertionTarget.md index 87ecbc534690..ac6405a701b3 100644 --- a/docs/v1/SyntheticsAssertionTarget.md +++ b/docs/v1/SyntheticsAssertionTarget.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **operator** | [**SyntheticsAssertionOperator**](SyntheticsAssertionOperator.md) | | | -| **property** | **String** | The associated assertion property. | [optional] | -| **target** | **Object** | Value used by the operator. | [optional] | -| **type** | [**SyntheticsAssertionType**](SyntheticsAssertionType.md) | | | +| Name | Type | Description | Notes | +| ------------ | ----------------------------------------------------------------- | ---------------------------------- | ---------- | +| **operator** | [**SyntheticsAssertionOperator**](SyntheticsAssertionOperator.md) | | | +| **property** | **String** | The associated assertion property. | [optional] | +| **target** | **Object** | Value used by the operator. | [optional] | +| **type** | [**SyntheticsAssertionType**](SyntheticsAssertionType.md) | | | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V1::SyntheticsAssertionTarget.new( type: null ) ``` - diff --git a/docs/v1/SyntheticsAssertionType.md b/docs/v1/SyntheticsAssertionType.md index 4afffaf4fe9d..c0817434a5cc 100644 --- a/docs/v1/SyntheticsAssertionType.md +++ b/docs/v1/SyntheticsAssertionType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::SyntheticsAssertionType.new() ``` - diff --git a/docs/v1/SyntheticsBasicAuth.md b/docs/v1/SyntheticsBasicAuth.md index 9729a3bbb3bf..e243a3ac6a49 100644 --- a/docs/v1/SyntheticsBasicAuth.md +++ b/docs/v1/SyntheticsBasicAuth.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **password** | **String** | Password to use for the basic authentication. | | -| **username** | **String** | Username to use for the basic authentication. | | +| Name | Type | Description | Notes | +| ------------ | ---------- | --------------------------------------------- | ----- | +| **password** | **String** | Password to use for the basic authentication. | | +| **username** | **String** | Username to use for the basic authentication. | | ## Example @@ -14,7 +14,6 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::SyntheticsBasicAuth.new( password: , - username: + username: ) ``` - diff --git a/docs/v1/SyntheticsBatchDetails.md b/docs/v1/SyntheticsBatchDetails.md index b4d3f9185b19..6f5a2528d818 100644 --- a/docs/v1/SyntheticsBatchDetails.md +++ b/docs/v1/SyntheticsBatchDetails.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**SyntheticsBatchDetailsData**](SyntheticsBatchDetailsData.md) | | [optional] | +| Name | Type | Description | Notes | +| -------- | --------------------------------------------------------------- | ----------- | ---------- | +| **data** | [**SyntheticsBatchDetailsData**](SyntheticsBatchDetailsData.md) | | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::SyntheticsBatchDetails.new( data: null ) ``` - diff --git a/docs/v1/SyntheticsBatchDetailsData.md b/docs/v1/SyntheticsBatchDetailsData.md index 30f6addf6a92..82c768cb071c 100644 --- a/docs/v1/SyntheticsBatchDetailsData.md +++ b/docs/v1/SyntheticsBatchDetailsData.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **metadata** | [**SyntheticsCIBatchMetadata**](SyntheticsCIBatchMetadata.md) | | [optional] | -| **results** | [**Array<SyntheticsBatchResult>**](SyntheticsBatchResult.md) | List of results for the batch. | [optional] | -| **status** | [**SyntheticsStatus**](SyntheticsStatus.md) | | [optional] | +| Name | Type | Description | Notes | +| ------------ | ------------------------------------------------------------------ | ------------------------------ | ---------- | +| **metadata** | [**SyntheticsCIBatchMetadata**](SyntheticsCIBatchMetadata.md) | | [optional] | +| **results** | [**Array<SyntheticsBatchResult>**](SyntheticsBatchResult.md) | List of results for the batch. | [optional] | +| **status** | [**SyntheticsStatus**](SyntheticsStatus.md) | | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::SyntheticsBatchDetailsData.new( status: null ) ``` - diff --git a/docs/v1/SyntheticsBatchResult.md b/docs/v1/SyntheticsBatchResult.md index 294373a47e9f..17b23c38dcc6 100644 --- a/docs/v1/SyntheticsBatchResult.md +++ b/docs/v1/SyntheticsBatchResult.md @@ -2,18 +2,18 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **device** | [**SyntheticsDeviceID**](SyntheticsDeviceID.md) | | [optional] | -| **duration** | **Float** | Total duration in millisecond of the test. | [optional] | -| **execution_rule** | [**SyntheticsTestExecutionRule**](SyntheticsTestExecutionRule.md) | | [optional] | -| **location** | **String** | Name of the location. | [optional] | -| **result_id** | **String** | The ID of the result to get. | [optional] | -| **retries** | **Float** | Total duration in millisecond of the test. | [optional] | -| **status** | [**SyntheticsStatus**](SyntheticsStatus.md) | | [optional] | -| **test_name** | **String** | Name of the test. | [optional] | -| **test_public_id** | **String** | The public ID of the Synthetic test. | [optional] | -| **test_type** | [**SyntheticsTestDetailsType**](SyntheticsTestDetailsType.md) | | [optional] | +| Name | Type | Description | Notes | +| ------------------ | ----------------------------------------------------------------- | ------------------------------------------ | ---------- | +| **device** | [**SyntheticsDeviceID**](SyntheticsDeviceID.md) | | [optional] | +| **duration** | **Float** | Total duration in millisecond of the test. | [optional] | +| **execution_rule** | [**SyntheticsTestExecutionRule**](SyntheticsTestExecutionRule.md) | | [optional] | +| **location** | **String** | Name of the location. | [optional] | +| **result_id** | **String** | The ID of the result to get. | [optional] | +| **retries** | **Float** | Total duration in millisecond of the test. | [optional] | +| **status** | [**SyntheticsStatus**](SyntheticsStatus.md) | | [optional] | +| **test_name** | **String** | Name of the test. | [optional] | +| **test_public_id** | **String** | The public ID of the Synthetic test. | [optional] | +| **test_type** | [**SyntheticsTestDetailsType**](SyntheticsTestDetailsType.md) | | [optional] | ## Example @@ -33,4 +33,3 @@ instance = DatadogAPIClient::V1::SyntheticsBatchResult.new( test_type: null ) ``` - diff --git a/docs/v1/SyntheticsBrowserError.md b/docs/v1/SyntheticsBrowserError.md index c355f3095d87..a004b567a437 100644 --- a/docs/v1/SyntheticsBrowserError.md +++ b/docs/v1/SyntheticsBrowserError.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **description** | **String** | Description of the error. | | -| **name** | **String** | Name of the error. | | -| **status** | **Integer** | Status Code of the error. | [optional] | -| **type** | [**SyntheticsBrowserErrorType**](SyntheticsBrowserErrorType.md) | | | +| Name | Type | Description | Notes | +| --------------- | --------------------------------------------------------------- | ------------------------- | ---------- | +| **description** | **String** | Description of the error. | | +| **name** | **String** | Name of the error. | | +| **status** | **Integer** | Status Code of the error. | [optional] | +| **type** | [**SyntheticsBrowserErrorType**](SyntheticsBrowserErrorType.md) | | | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V1::SyntheticsBrowserError.new( type: null ) ``` - diff --git a/docs/v1/SyntheticsBrowserErrorType.md b/docs/v1/SyntheticsBrowserErrorType.md index 5562ee28068e..ea828e377307 100644 --- a/docs/v1/SyntheticsBrowserErrorType.md +++ b/docs/v1/SyntheticsBrowserErrorType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::SyntheticsBrowserErrorType.new() ``` - diff --git a/docs/v1/SyntheticsBrowserTest.md b/docs/v1/SyntheticsBrowserTest.md index d922a2431352..48c1138993e1 100644 --- a/docs/v1/SyntheticsBrowserTest.md +++ b/docs/v1/SyntheticsBrowserTest.md @@ -2,19 +2,19 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **config** | [**SyntheticsBrowserTestConfig**](SyntheticsBrowserTestConfig.md) | | [optional] | -| **locations** | **Array<String>** | Array of locations used to run the test. | [optional] | -| **message** | **String** | Notification message associated with the test. Message can either be text or an empty string. | | -| **monitor_id** | **Integer** | The associated monitor ID. | [optional][readonly] | -| **name** | **String** | Name of the test. | [optional] | -| **options** | [**SyntheticsTestOptions**](SyntheticsTestOptions.md) | | [optional] | -| **public_id** | **String** | The public ID of the test. | [optional][readonly] | -| **status** | [**SyntheticsTestPauseStatus**](SyntheticsTestPauseStatus.md) | | [optional] | -| **steps** | [**Array<SyntheticsStep>**](SyntheticsStep.md) | The steps of the test. | [optional] | -| **tags** | **Array<String>** | Array of tags attached to the test. | [optional] | -| **type** | [**SyntheticsBrowserTestType**](SyntheticsBrowserTestType.md) | | [optional][default to 'browser'] | +| Name | Type | Description | Notes | +| -------------- | ----------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | ---------------------------------------- | +| **config** | [**SyntheticsBrowserTestConfig**](SyntheticsBrowserTestConfig.md) | | [optional] | +| **locations** | **Array<String>** | Array of locations used to run the test. | [optional] | +| **message** | **String** | Notification message associated with the test. Message can either be text or an empty string. | | +| **monitor_id** | **Integer** | The associated monitor ID. | [optional][readonly] | +| **name** | **String** | Name of the test. | [optional] | +| **options** | [**SyntheticsTestOptions**](SyntheticsTestOptions.md) | | [optional] | +| **public_id** | **String** | The public ID of the test. | [optional][readonly] | +| **status** | [**SyntheticsTestPauseStatus**](SyntheticsTestPauseStatus.md) | | [optional] | +| **steps** | [**Array<SyntheticsStep>**](SyntheticsStep.md) | The steps of the test. | [optional] | +| **tags** | **Array<String>** | Array of tags attached to the test. | [optional] | +| **type** | [**SyntheticsBrowserTestType**](SyntheticsBrowserTestType.md) | | [optional][default to 'browser'] | ## Example @@ -35,4 +35,3 @@ instance = DatadogAPIClient::V1::SyntheticsBrowserTest.new( type: null ) ``` - diff --git a/docs/v1/SyntheticsBrowserTestConfig.md b/docs/v1/SyntheticsBrowserTestConfig.md index 761384257872..ff5b35745b3f 100644 --- a/docs/v1/SyntheticsBrowserTestConfig.md +++ b/docs/v1/SyntheticsBrowserTestConfig.md @@ -2,13 +2,13 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **assertions** | [**Array<SyntheticsAssertion>**](SyntheticsAssertion.md) | Array of assertions used for the test. | | -| **config_variables** | [**Array<SyntheticsConfigVariable>**](SyntheticsConfigVariable.md) | Array of variables used for the test. | [optional] | -| **request** | [**SyntheticsTestRequest**](SyntheticsTestRequest.md) | | | -| **set_cookie** | **String** | Cookies to be used for the request, using the [Set-Cookie](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie) syntax. | [optional] | -| **variables** | [**Array<SyntheticsBrowserVariable>**](SyntheticsBrowserVariable.md) | Array of variables used for the test steps. | [optional] | +| Name | Type | Description | Notes | +| -------------------- | -------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **assertions** | [**Array<SyntheticsAssertion>**](SyntheticsAssertion.md) | Array of assertions used for the test. | | +| **config_variables** | [**Array<SyntheticsConfigVariable>**](SyntheticsConfigVariable.md) | Array of variables used for the test. | [optional] | +| **request** | [**SyntheticsTestRequest**](SyntheticsTestRequest.md) | | | +| **set_cookie** | **String** | Cookies to be used for the request, using the [Set-Cookie](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie) syntax. | [optional] | +| **variables** | [**Array<SyntheticsBrowserVariable>**](SyntheticsBrowserVariable.md) | Array of variables used for the test steps. | [optional] | ## Example @@ -23,4 +23,3 @@ instance = DatadogAPIClient::V1::SyntheticsBrowserTestConfig.new( variables: null ) ``` - diff --git a/docs/v1/SyntheticsBrowserTestResultData.md b/docs/v1/SyntheticsBrowserTestResultData.md index 9a69efd0a732..82a95e8ed643 100644 --- a/docs/v1/SyntheticsBrowserTestResultData.md +++ b/docs/v1/SyntheticsBrowserTestResultData.md @@ -2,19 +2,19 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **browser_type** | **String** | Type of browser device used for the browser test. | [optional] | -| **browser_version** | **String** | Browser version used for the browser test. | [optional] | -| **device** | [**SyntheticsDevice**](SyntheticsDevice.md) | | [optional] | -| **duration** | **Float** | Global duration in second of the browser test. | [optional] | -| **error** | **String** | Error returned for the browser test. | [optional] | -| **passed** | **Boolean** | Whether or not the browser test was conducted. | [optional] | -| **received_email_count** | **Integer** | The amount of email received during the browser test. | [optional] | -| **start_url** | **String** | Starting URL for the browser test. | [optional] | -| **step_details** | [**Array<SyntheticsStepDetail>**](SyntheticsStepDetail.md) | Array containing the different browser test steps. | [optional] | -| **thumbnails_bucket_key** | **Boolean** | Whether or not a thumbnail is associated with the browser test. | [optional] | -| **time_to_interactive** | **Float** | Time in second to wait before the browser test starts after reaching the start URL. | [optional] | +| Name | Type | Description | Notes | +| ------------------------- | ---------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ---------- | +| **browser_type** | **String** | Type of browser device used for the browser test. | [optional] | +| **browser_version** | **String** | Browser version used for the browser test. | [optional] | +| **device** | [**SyntheticsDevice**](SyntheticsDevice.md) | | [optional] | +| **duration** | **Float** | Global duration in second of the browser test. | [optional] | +| **error** | **String** | Error returned for the browser test. | [optional] | +| **passed** | **Boolean** | Whether or not the browser test was conducted. | [optional] | +| **received_email_count** | **Integer** | The amount of email received during the browser test. | [optional] | +| **start_url** | **String** | Starting URL for the browser test. | [optional] | +| **step_details** | [**Array<SyntheticsStepDetail>**](SyntheticsStepDetail.md) | Array containing the different browser test steps. | [optional] | +| **thumbnails_bucket_key** | **Boolean** | Whether or not a thumbnail is associated with the browser test. | [optional] | +| **time_to_interactive** | **Float** | Time in second to wait before the browser test starts after reaching the start URL. | [optional] | ## Example @@ -35,4 +35,3 @@ instance = DatadogAPIClient::V1::SyntheticsBrowserTestResultData.new( time_to_interactive: null ) ``` - diff --git a/docs/v1/SyntheticsBrowserTestResultFull.md b/docs/v1/SyntheticsBrowserTestResultFull.md index 32b713499e72..d95fdbe8a103 100644 --- a/docs/v1/SyntheticsBrowserTestResultFull.md +++ b/docs/v1/SyntheticsBrowserTestResultFull.md @@ -2,15 +2,15 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **check** | [**SyntheticsBrowserTestResultFullCheck**](SyntheticsBrowserTestResultFullCheck.md) | | [optional] | -| **check_time** | **Float** | When the browser test was conducted. | [optional] | -| **check_version** | **Integer** | Version of the browser test used. | [optional] | -| **probe_dc** | **String** | Location from which the browser test was performed. | [optional] | -| **result** | [**SyntheticsBrowserTestResultData**](SyntheticsBrowserTestResultData.md) | | [optional] | -| **result_id** | **String** | ID of the browser test result. | [optional] | -| **status** | [**SyntheticsTestMonitorStatus**](SyntheticsTestMonitorStatus.md) | | [optional] | +| Name | Type | Description | Notes | +| ----------------- | ----------------------------------------------------------------------------------- | --------------------------------------------------- | ---------- | +| **check** | [**SyntheticsBrowserTestResultFullCheck**](SyntheticsBrowserTestResultFullCheck.md) | | [optional] | +| **check_time** | **Float** | When the browser test was conducted. | [optional] | +| **check_version** | **Integer** | Version of the browser test used. | [optional] | +| **probe_dc** | **String** | Location from which the browser test was performed. | [optional] | +| **result** | [**SyntheticsBrowserTestResultData**](SyntheticsBrowserTestResultData.md) | | [optional] | +| **result_id** | **String** | ID of the browser test result. | [optional] | +| **status** | [**SyntheticsTestMonitorStatus**](SyntheticsTestMonitorStatus.md) | | [optional] | ## Example @@ -27,4 +27,3 @@ instance = DatadogAPIClient::V1::SyntheticsBrowserTestResultFull.new( status: null ) ``` - diff --git a/docs/v1/SyntheticsBrowserTestResultFullCheck.md b/docs/v1/SyntheticsBrowserTestResultFullCheck.md index 88918558e879..bf214f2f2ac2 100644 --- a/docs/v1/SyntheticsBrowserTestResultFullCheck.md +++ b/docs/v1/SyntheticsBrowserTestResultFullCheck.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **config** | [**SyntheticsTestConfig**](SyntheticsTestConfig.md) | | | +| Name | Type | Description | Notes | +| ---------- | --------------------------------------------------- | ----------- | ----- | +| **config** | [**SyntheticsTestConfig**](SyntheticsTestConfig.md) | | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::SyntheticsBrowserTestResultFullCheck.new( config: null ) ``` - diff --git a/docs/v1/SyntheticsBrowserTestResultShort.md b/docs/v1/SyntheticsBrowserTestResultShort.md index 0120afb071ba..1fb50a0ecd2e 100644 --- a/docs/v1/SyntheticsBrowserTestResultShort.md +++ b/docs/v1/SyntheticsBrowserTestResultShort.md @@ -2,13 +2,13 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **check_time** | **Float** | Last time the browser test was performed. | [optional] | -| **probe_dc** | **String** | Location from which the Browser test was performed. | [optional] | -| **result** | [**SyntheticsBrowserTestResultShortResult**](SyntheticsBrowserTestResultShortResult.md) | | [optional] | -| **result_id** | **String** | ID of the browser test result. | [optional] | -| **status** | [**SyntheticsTestMonitorStatus**](SyntheticsTestMonitorStatus.md) | | [optional] | +| Name | Type | Description | Notes | +| -------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------- | ---------- | +| **check_time** | **Float** | Last time the browser test was performed. | [optional] | +| **probe_dc** | **String** | Location from which the Browser test was performed. | [optional] | +| **result** | [**SyntheticsBrowserTestResultShortResult**](SyntheticsBrowserTestResultShortResult.md) | | [optional] | +| **result_id** | **String** | ID of the browser test result. | [optional] | +| **status** | [**SyntheticsTestMonitorStatus**](SyntheticsTestMonitorStatus.md) | | [optional] | ## Example @@ -23,4 +23,3 @@ instance = DatadogAPIClient::V1::SyntheticsBrowserTestResultShort.new( status: null ) ``` - diff --git a/docs/v1/SyntheticsBrowserTestResultShortResult.md b/docs/v1/SyntheticsBrowserTestResultShortResult.md index 72ba0422150b..42a040399b64 100644 --- a/docs/v1/SyntheticsBrowserTestResultShortResult.md +++ b/docs/v1/SyntheticsBrowserTestResultShortResult.md @@ -2,13 +2,13 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **device** | [**SyntheticsDevice**](SyntheticsDevice.md) | | [optional] | -| **duration** | **Float** | Length in second of the browser test run. | [optional] | -| **error_count** | **Integer** | Amount of errors collected for a single browser test run. | [optional] | -| **step_count_completed** | **Integer** | Amount of browser test steps completed before failing. | [optional] | -| **step_count_total** | **Integer** | Total amount of browser test steps. | [optional] | +| Name | Type | Description | Notes | +| ------------------------ | ------------------------------------------- | --------------------------------------------------------- | ---------- | +| **device** | [**SyntheticsDevice**](SyntheticsDevice.md) | | [optional] | +| **duration** | **Float** | Length in second of the browser test run. | [optional] | +| **error_count** | **Integer** | Amount of errors collected for a single browser test run. | [optional] | +| **step_count_completed** | **Integer** | Amount of browser test steps completed before failing. | [optional] | +| **step_count_total** | **Integer** | Total amount of browser test steps. | [optional] | ## Example @@ -23,4 +23,3 @@ instance = DatadogAPIClient::V1::SyntheticsBrowserTestResultShortResult.new( step_count_total: null ) ``` - diff --git a/docs/v1/SyntheticsBrowserTestType.md b/docs/v1/SyntheticsBrowserTestType.md index 2d8a553518a9..ad36cbe93b7e 100644 --- a/docs/v1/SyntheticsBrowserTestType.md +++ b/docs/v1/SyntheticsBrowserTestType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::SyntheticsBrowserTestType.new() ``` - diff --git a/docs/v1/SyntheticsBrowserVariable.md b/docs/v1/SyntheticsBrowserVariable.md index 895245d62678..02cc669c4177 100644 --- a/docs/v1/SyntheticsBrowserVariable.md +++ b/docs/v1/SyntheticsBrowserVariable.md @@ -2,13 +2,13 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **example** | **String** | Example for the variable. | [optional] | -| **id** | **String** | ID for the variable. | [optional] | -| **name** | **String** | Name of the variable. | | -| **pattern** | **String** | Pattern of the variable. | [optional] | -| **type** | [**SyntheticsBrowserVariableType**](SyntheticsBrowserVariableType.md) | | | +| Name | Type | Description | Notes | +| ----------- | --------------------------------------------------------------------- | ------------------------- | ---------- | +| **example** | **String** | Example for the variable. | [optional] | +| **id** | **String** | ID for the variable. | [optional] | +| **name** | **String** | Name of the variable. | | +| **pattern** | **String** | Pattern of the variable. | [optional] | +| **type** | [**SyntheticsBrowserVariableType**](SyntheticsBrowserVariableType.md) | | | ## Example @@ -23,4 +23,3 @@ instance = DatadogAPIClient::V1::SyntheticsBrowserVariable.new( type: null ) ``` - diff --git a/docs/v1/SyntheticsBrowserVariableType.md b/docs/v1/SyntheticsBrowserVariableType.md index 3679e39f5a17..1f67e1b465f4 100644 --- a/docs/v1/SyntheticsBrowserVariableType.md +++ b/docs/v1/SyntheticsBrowserVariableType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::SyntheticsBrowserVariableType.new() ``` - diff --git a/docs/v1/SyntheticsCIBatchMetadata.md b/docs/v1/SyntheticsCIBatchMetadata.md index 92fe9aaa09cb..a85ba62775e4 100644 --- a/docs/v1/SyntheticsCIBatchMetadata.md +++ b/docs/v1/SyntheticsCIBatchMetadata.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **ci** | [**SyntheticsCIBatchMetadataCI**](SyntheticsCIBatchMetadataCI.md) | | [optional] | -| **git** | [**SyntheticsCIBatchMetadataGit**](SyntheticsCIBatchMetadataGit.md) | | [optional] | +| Name | Type | Description | Notes | +| ------- | ------------------------------------------------------------------- | ----------- | ---------- | +| **ci** | [**SyntheticsCIBatchMetadataCI**](SyntheticsCIBatchMetadataCI.md) | | [optional] | +| **git** | [**SyntheticsCIBatchMetadataGit**](SyntheticsCIBatchMetadataGit.md) | | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::SyntheticsCIBatchMetadata.new( git: null ) ``` - diff --git a/docs/v1/SyntheticsCIBatchMetadataCI.md b/docs/v1/SyntheticsCIBatchMetadataCI.md index 1b61be8966be..2d10978ee950 100644 --- a/docs/v1/SyntheticsCIBatchMetadataCI.md +++ b/docs/v1/SyntheticsCIBatchMetadataCI.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **pipeline** | **String** | Name of the pipeline. | [optional] | +| Name | Type | Description | Notes | +| ------------ | ---------- | ------------------------ | ---------- | +| **pipeline** | **String** | Name of the pipeline. | [optional] | | **provider** | **String** | Name of the CI provider. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::SyntheticsCIBatchMetadataCI.new( provider: null ) ``` - diff --git a/docs/v1/SyntheticsCIBatchMetadataGit.md b/docs/v1/SyntheticsCIBatchMetadataGit.md index b60154cdeb86..7e2d9a760fc9 100644 --- a/docs/v1/SyntheticsCIBatchMetadataGit.md +++ b/docs/v1/SyntheticsCIBatchMetadataGit.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **branch** | **String** | The branch name. | [optional] | -| **commit_sha** | **String** | The commit SHA. | [optional] | +| Name | Type | Description | Notes | +| -------------- | ---------- | ---------------- | ---------- | +| **branch** | **String** | The branch name. | [optional] | +| **commit_sha** | **String** | The commit SHA. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::SyntheticsCIBatchMetadataGit.new( commit_sha: null ) ``` - diff --git a/docs/v1/SyntheticsCITest.md b/docs/v1/SyntheticsCITest.md index 153f948257ef..c21449b694b6 100644 --- a/docs/v1/SyntheticsCITest.md +++ b/docs/v1/SyntheticsCITest.md @@ -2,22 +2,22 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **allow_insecure_certificates** | **Boolean** | Disable certificate checks in API tests. | [optional] | -| **basic_auth** | [**SyntheticsBasicAuth**](SyntheticsBasicAuth.md) | | [optional] | -| **body** | **String** | Body to include in the test. | [optional] | -| **body_type** | **String** | Type of the data sent in a synthetics API test. | [optional] | -| **cookies** | **String** | Cookies for the request. | [optional] | -| **device_ids** | [**Array<SyntheticsDeviceID>**](SyntheticsDeviceID.md) | For browser test, array with the different device IDs used to run the test. | [optional] | -| **follow_redirects** | **Boolean** | For API HTTP test, whether or not the test should follow redirects. | [optional] | -| **headers** | **Hash<String, String>** | Headers to include when performing the test. | [optional] | -| **locations** | **Array<String>** | Array of locations used to run the test. | [optional] | -| **metadata** | [**SyntheticsCIBatchMetadata**](SyntheticsCIBatchMetadata.md) | | [optional] | -| **public_id** | **String** | The public ID of the Synthetics test to trigger. | | -| **_retry** | [**SyntheticsTestOptionsRetry**](SyntheticsTestOptionsRetry.md) | | [optional] | -| **start_url** | **String** | Starting URL for the browser test. | [optional] | -| **variables** | **Hash<String, String>** | Variables to replace in the test. | [optional] | +| Name | Type | Description | Notes | +| ------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------------------- | ---------- | +| **allow_insecure_certificates** | **Boolean** | Disable certificate checks in API tests. | [optional] | +| **basic_auth** | [**SyntheticsBasicAuth**](SyntheticsBasicAuth.md) | | [optional] | +| **body** | **String** | Body to include in the test. | [optional] | +| **body_type** | **String** | Type of the data sent in a synthetics API test. | [optional] | +| **cookies** | **String** | Cookies for the request. | [optional] | +| **device_ids** | [**Array<SyntheticsDeviceID>**](SyntheticsDeviceID.md) | For browser test, array with the different device IDs used to run the test. | [optional] | +| **follow_redirects** | **Boolean** | For API HTTP test, whether or not the test should follow redirects. | [optional] | +| **headers** | **Hash<String, String>** | Headers to include when performing the test. | [optional] | +| **locations** | **Array<String>** | Array of locations used to run the test. | [optional] | +| **metadata** | [**SyntheticsCIBatchMetadata**](SyntheticsCIBatchMetadata.md) | | [optional] | +| **public_id** | **String** | The public ID of the Synthetics test to trigger. | | +| **\_retry** | [**SyntheticsTestOptionsRetry**](SyntheticsTestOptionsRetry.md) | | [optional] | +| **start_url** | **String** | Starting URL for the browser test. | [optional] | +| **variables** | **Hash<String, String>** | Variables to replace in the test. | [optional] | ## Example @@ -41,4 +41,3 @@ instance = DatadogAPIClient::V1::SyntheticsCITest.new( variables: null ) ``` - diff --git a/docs/v1/SyntheticsCITestBody.md b/docs/v1/SyntheticsCITestBody.md index b454099c0c90..77bc818fea3e 100644 --- a/docs/v1/SyntheticsCITestBody.md +++ b/docs/v1/SyntheticsCITestBody.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| --------- | -------------------------------------------------------- | --------------------------- | ---------- | | **tests** | [**Array<SyntheticsCITest>**](SyntheticsCITest.md) | Individual synthetics test. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::SyntheticsCITestBody.new( tests: null ) ``` - diff --git a/docs/v1/SyntheticsCheckType.md b/docs/v1/SyntheticsCheckType.md index 72795d8b0dcf..aca07b5df8af 100644 --- a/docs/v1/SyntheticsCheckType.md +++ b/docs/v1/SyntheticsCheckType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::SyntheticsCheckType.new() ``` - diff --git a/docs/v1/SyntheticsConfigVariable.md b/docs/v1/SyntheticsConfigVariable.md index 5c48c43af70a..380c42fe46d6 100644 --- a/docs/v1/SyntheticsConfigVariable.md +++ b/docs/v1/SyntheticsConfigVariable.md @@ -2,13 +2,13 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **example** | **String** | Example for the variable. | [optional] | -| **id** | **String** | ID of the variable for global variables. | [optional] | -| **name** | **String** | Name of the variable. | | -| **pattern** | **String** | Pattern of the variable. | [optional] | -| **type** | [**SyntheticsConfigVariableType**](SyntheticsConfigVariableType.md) | | | +| Name | Type | Description | Notes | +| ----------- | ------------------------------------------------------------------- | ---------------------------------------- | ---------- | +| **example** | **String** | Example for the variable. | [optional] | +| **id** | **String** | ID of the variable for global variables. | [optional] | +| **name** | **String** | Name of the variable. | | +| **pattern** | **String** | Pattern of the variable. | [optional] | +| **type** | [**SyntheticsConfigVariableType**](SyntheticsConfigVariableType.md) | | | ## Example @@ -23,4 +23,3 @@ instance = DatadogAPIClient::V1::SyntheticsConfigVariable.new( type: null ) ``` - diff --git a/docs/v1/SyntheticsConfigVariableType.md b/docs/v1/SyntheticsConfigVariableType.md index 440e191876ab..dff3d312d894 100644 --- a/docs/v1/SyntheticsConfigVariableType.md +++ b/docs/v1/SyntheticsConfigVariableType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::SyntheticsConfigVariableType.new() ``` - diff --git a/docs/v1/SyntheticsCoreWebVitals.md b/docs/v1/SyntheticsCoreWebVitals.md index 250a1b51aca0..e355505b648d 100644 --- a/docs/v1/SyntheticsCoreWebVitals.md +++ b/docs/v1/SyntheticsCoreWebVitals.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **cls** | **Integer** | Cumulative Layout Shift. | [optional] | +| Name | Type | Description | Notes | +| ------- | ----------- | ----------------------------------------- | ---------- | +| **cls** | **Integer** | Cumulative Layout Shift. | [optional] | | **lcp** | **Integer** | Largest Contentful Paint in milliseconds. | [optional] | -| **url** | **String** | URL attached to the metrics. | [optional] | +| **url** | **String** | URL attached to the metrics. | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::SyntheticsCoreWebVitals.new( url: null ) ``` - diff --git a/docs/v1/SyntheticsDeleteTestsPayload.md b/docs/v1/SyntheticsDeleteTestsPayload.md index 983c824c3fe3..6a43ad486f9f 100644 --- a/docs/v1/SyntheticsDeleteTestsPayload.md +++ b/docs/v1/SyntheticsDeleteTestsPayload.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| -------------- | ----------------------- | -------------------------------------------------- | ---------- | | **public_ids** | **Array<String>** | An array of Synthetic test IDs you want to delete. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::SyntheticsDeleteTestsPayload.new( public_ids: [] ) ``` - diff --git a/docs/v1/SyntheticsDeleteTestsResponse.md b/docs/v1/SyntheticsDeleteTestsResponse.md index 359ddeab0f2d..e8da50597ff8 100644 --- a/docs/v1/SyntheticsDeleteTestsResponse.md +++ b/docs/v1/SyntheticsDeleteTestsResponse.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| ----------------- | ------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------- | ---------- | | **deleted_tests** | [**Array<SyntheticsDeletedTest>**](SyntheticsDeletedTest.md) | Array of objects containing a deleted Synthetic test ID with the associated deletion timestamp. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::SyntheticsDeleteTestsResponse.new( deleted_tests: null ) ``` - diff --git a/docs/v1/SyntheticsDeletedTest.md b/docs/v1/SyntheticsDeletedTest.md index f6dbbb10af83..55cd99826be8 100644 --- a/docs/v1/SyntheticsDeletedTest.md +++ b/docs/v1/SyntheticsDeletedTest.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **deleted_at** | **Time** | Deletion timestamp of the Synthetic test ID. | [optional] | -| **public_id** | **String** | The Synthetic test ID deleted. | [optional] | +| Name | Type | Description | Notes | +| -------------- | ---------- | -------------------------------------------- | ---------- | +| **deleted_at** | **Time** | Deletion timestamp of the Synthetic test ID. | [optional] | +| **public_id** | **String** | The Synthetic test ID deleted. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::SyntheticsDeletedTest.new( public_id: null ) ``` - diff --git a/docs/v1/SyntheticsDevice.md b/docs/v1/SyntheticsDevice.md index f951339f6aee..0f9fe6c6c12b 100644 --- a/docs/v1/SyntheticsDevice.md +++ b/docs/v1/SyntheticsDevice.md @@ -2,13 +2,13 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **height** | **Integer** | Screen height of the device. | | -| **id** | [**SyntheticsDeviceID**](SyntheticsDeviceID.md) | | | -| **is_mobile** | **Boolean** | Whether or not the device is a mobile. | [optional] | -| **name** | **String** | The device name. | | -| **width** | **Integer** | Screen width of the device. | | +| Name | Type | Description | Notes | +| ------------- | ----------------------------------------------- | -------------------------------------- | ---------- | +| **height** | **Integer** | Screen height of the device. | | +| **id** | [**SyntheticsDeviceID**](SyntheticsDeviceID.md) | | | +| **is_mobile** | **Boolean** | Whether or not the device is a mobile. | [optional] | +| **name** | **String** | The device name. | | +| **width** | **Integer** | Screen width of the device. | | ## Example @@ -23,4 +23,3 @@ instance = DatadogAPIClient::V1::SyntheticsDevice.new( width: 0 ) ``` - diff --git a/docs/v1/SyntheticsDeviceID.md b/docs/v1/SyntheticsDeviceID.md index f9d257cc75c1..c8089ff86fdc 100644 --- a/docs/v1/SyntheticsDeviceID.md +++ b/docs/v1/SyntheticsDeviceID.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::SyntheticsDeviceID.new() ``` - diff --git a/docs/v1/SyntheticsErrorCode.md b/docs/v1/SyntheticsErrorCode.md index 1328549b2a57..6538c1c74d45 100644 --- a/docs/v1/SyntheticsErrorCode.md +++ b/docs/v1/SyntheticsErrorCode.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::SyntheticsErrorCode.new() ``` - diff --git a/docs/v1/SyntheticsGetAPITestLatestResultsResponse.md b/docs/v1/SyntheticsGetAPITestLatestResultsResponse.md index d0b94fd96b12..97629fb97fe4 100644 --- a/docs/v1/SyntheticsGetAPITestLatestResultsResponse.md +++ b/docs/v1/SyntheticsGetAPITestLatestResultsResponse.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **last_timestamp_fetched** | **Integer** | Timestamp of the latest API test run. | [optional] | -| **results** | [**Array<SyntheticsAPITestResultShort>**](SyntheticsAPITestResultShort.md) | Result of the latest API test run. | [optional] | +| Name | Type | Description | Notes | +| -------------------------- | -------------------------------------------------------------------------------- | ------------------------------------- | ---------- | +| **last_timestamp_fetched** | **Integer** | Timestamp of the latest API test run. | [optional] | +| **results** | [**Array<SyntheticsAPITestResultShort>**](SyntheticsAPITestResultShort.md) | Result of the latest API test run. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::SyntheticsGetAPITestLatestResultsResponse.new( results: null ) ``` - diff --git a/docs/v1/SyntheticsGetBrowserTestLatestResultsResponse.md b/docs/v1/SyntheticsGetBrowserTestLatestResultsResponse.md index a44fed6d42dd..9b9dd98f43ea 100644 --- a/docs/v1/SyntheticsGetBrowserTestLatestResultsResponse.md +++ b/docs/v1/SyntheticsGetBrowserTestLatestResultsResponse.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **last_timestamp_fetched** | **Integer** | Timestamp of the latest browser test run. | [optional] | -| **results** | [**Array<SyntheticsBrowserTestResultShort>**](SyntheticsBrowserTestResultShort.md) | Result of the latest browser test run. | [optional] | +| Name | Type | Description | Notes | +| -------------------------- | ---------------------------------------------------------------------------------------- | ----------------------------------------- | ---------- | +| **last_timestamp_fetched** | **Integer** | Timestamp of the latest browser test run. | [optional] | +| **results** | [**Array<SyntheticsBrowserTestResultShort>**](SyntheticsBrowserTestResultShort.md) | Result of the latest browser test run. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::SyntheticsGetBrowserTestLatestResultsResponse.n results: null ) ``` - diff --git a/docs/v1/SyntheticsGlobalVariable.md b/docs/v1/SyntheticsGlobalVariable.md index c963237ad26f..57a01cc2b98c 100644 --- a/docs/v1/SyntheticsGlobalVariable.md +++ b/docs/v1/SyntheticsGlobalVariable.md @@ -2,16 +2,16 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**SyntheticsGlobalVariableAttributes**](SyntheticsGlobalVariableAttributes.md) | | [optional] | -| **description** | **String** | Description of the global variable. | | -| **id** | **String** | Unique identifier of the global variable. | [optional][readonly] | -| **name** | **String** | Name of the global variable. | | -| **parse_test_options** | [**SyntheticsGlobalVariableParseTestOptions**](SyntheticsGlobalVariableParseTestOptions.md) | | [optional] | -| **parse_test_public_id** | **String** | A Synthetic test ID to use as a test to generate the variable value. | [optional] | -| **tags** | **Array<String>** | Tags of the global variable. | | -| **value** | [**SyntheticsGlobalVariableValue**](SyntheticsGlobalVariableValue.md) | | | +| Name | Type | Description | Notes | +| ------------------------ | ------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------- | +| **attributes** | [**SyntheticsGlobalVariableAttributes**](SyntheticsGlobalVariableAttributes.md) | | [optional] | +| **description** | **String** | Description of the global variable. | | +| **id** | **String** | Unique identifier of the global variable. | [optional][readonly] | +| **name** | **String** | Name of the global variable. | | +| **parse_test_options** | [**SyntheticsGlobalVariableParseTestOptions**](SyntheticsGlobalVariableParseTestOptions.md) | | [optional] | +| **parse_test_public_id** | **String** | A Synthetic test ID to use as a test to generate the variable value. | [optional] | +| **tags** | **Array<String>** | Tags of the global variable. | | +| **value** | [**SyntheticsGlobalVariableValue**](SyntheticsGlobalVariableValue.md) | | | ## Example @@ -29,4 +29,3 @@ instance = DatadogAPIClient::V1::SyntheticsGlobalVariable.new( value: null ) ``` - diff --git a/docs/v1/SyntheticsGlobalVariableAttributes.md b/docs/v1/SyntheticsGlobalVariableAttributes.md index 3218b7c48732..2a9532c0a11b 100644 --- a/docs/v1/SyntheticsGlobalVariableAttributes.md +++ b/docs/v1/SyntheticsGlobalVariableAttributes.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| -------------------- | ----------------------- | --------------------------------------------------------------- | ---------- | | **restricted_roles** | **Array<String>** | List of role identifiers that can be pulled from the Roles API. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::SyntheticsGlobalVariableAttributes.new( restricted_roles: null ) ``` - diff --git a/docs/v1/SyntheticsGlobalVariableParseTestOptions.md b/docs/v1/SyntheticsGlobalVariableParseTestOptions.md index 4181d68ee19b..09ae33f3f4d1 100644 --- a/docs/v1/SyntheticsGlobalVariableParseTestOptions.md +++ b/docs/v1/SyntheticsGlobalVariableParseTestOptions.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **field** | **String** | When type is `http_header`, name of the header to use to extract the value. | [optional] | -| **parser** | [**SyntheticsVariableParser**](SyntheticsVariableParser.md) | | | -| **type** | [**SyntheticsGlobalVariableParseTestOptionsType**](SyntheticsGlobalVariableParseTestOptionsType.md) | | | +| Name | Type | Description | Notes | +| ---------- | --------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ---------- | +| **field** | **String** | When type is `http_header`, name of the header to use to extract the value. | [optional] | +| **parser** | [**SyntheticsVariableParser**](SyntheticsVariableParser.md) | | | +| **type** | [**SyntheticsGlobalVariableParseTestOptionsType**](SyntheticsGlobalVariableParseTestOptionsType.md) | | | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::SyntheticsGlobalVariableParseTestOptions.new( type: null ) ``` - diff --git a/docs/v1/SyntheticsGlobalVariableParseTestOptionsType.md b/docs/v1/SyntheticsGlobalVariableParseTestOptionsType.md index 26d2e793c091..2a718c905802 100644 --- a/docs/v1/SyntheticsGlobalVariableParseTestOptionsType.md +++ b/docs/v1/SyntheticsGlobalVariableParseTestOptionsType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::SyntheticsGlobalVariableParseTestOptionsType.new() ``` - diff --git a/docs/v1/SyntheticsGlobalVariableParserType.md b/docs/v1/SyntheticsGlobalVariableParserType.md index 09d03d47d389..60b417709ef7 100644 --- a/docs/v1/SyntheticsGlobalVariableParserType.md +++ b/docs/v1/SyntheticsGlobalVariableParserType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::SyntheticsGlobalVariableParserType.new() ``` - diff --git a/docs/v1/SyntheticsGlobalVariableValue.md b/docs/v1/SyntheticsGlobalVariableValue.md index 7298cf097790..85e0dde3e1e1 100644 --- a/docs/v1/SyntheticsGlobalVariableValue.md +++ b/docs/v1/SyntheticsGlobalVariableValue.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **secure** | **Boolean** | Determines if the value of the variable is hidden. | [optional] | -| **value** | **String** | Value of the global variable. When reading a global variable, the value will not be present if the variable is hidden with the `secure` property. | [optional] | +| Name | Type | Description | Notes | +| ---------- | ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **secure** | **Boolean** | Determines if the value of the variable is hidden. | [optional] | +| **value** | **String** | Value of the global variable. When reading a global variable, the value will not be present if the variable is hidden with the `secure` property. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::SyntheticsGlobalVariableValue.new( value: example-value ) ``` - diff --git a/docs/v1/SyntheticsListGlobalVariablesResponse.md b/docs/v1/SyntheticsListGlobalVariablesResponse.md index 6b0531f017c4..9c2d02e31026 100644 --- a/docs/v1/SyntheticsListGlobalVariablesResponse.md +++ b/docs/v1/SyntheticsListGlobalVariablesResponse.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| ------------- | ------------------------------------------------------------------------ | ------------------------------------ | ---------- | | **variables** | [**Array<SyntheticsGlobalVariable>**](SyntheticsGlobalVariable.md) | Array of Synthetic global variables. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::SyntheticsListGlobalVariablesResponse.new( variables: null ) ``` - diff --git a/docs/v1/SyntheticsListTestsResponse.md b/docs/v1/SyntheticsListTestsResponse.md index 97185ee41597..9dee3e77425d 100644 --- a/docs/v1/SyntheticsListTestsResponse.md +++ b/docs/v1/SyntheticsListTestsResponse.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| --------- | ------------------------------------------------------------------ | --------------------------------------- | ---------- | | **tests** | [**Array<SyntheticsTestDetails>**](SyntheticsTestDetails.md) | Array of Synthetic tests configuration. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::SyntheticsListTestsResponse.new( tests: null ) ``` - diff --git a/docs/v1/SyntheticsLocation.md b/docs/v1/SyntheticsLocation.md index 3ae69b63f6d4..90fef5dfc5ca 100644 --- a/docs/v1/SyntheticsLocation.md +++ b/docs/v1/SyntheticsLocation.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **id** | **String** | Unique identifier of the location. | [optional] | -| **name** | **String** | Name of the location. | [optional] | +| Name | Type | Description | Notes | +| -------- | ---------- | ---------------------------------- | ---------- | +| **id** | **String** | Unique identifier of the location. | [optional] | +| **name** | **String** | Name of the location. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::SyntheticsLocation.new( name: null ) ``` - diff --git a/docs/v1/SyntheticsLocations.md b/docs/v1/SyntheticsLocations.md index 73241c9c66c3..bb904a3e3799 100644 --- a/docs/v1/SyntheticsLocations.md +++ b/docs/v1/SyntheticsLocations.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| ------------- | ------------------------------------------------------------ | ----------------------------- | ---------- | | **locations** | [**Array<SyntheticsLocation>**](SyntheticsLocation.md) | List of Synthetics locations. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::SyntheticsLocations.new( locations: null ) ``` - diff --git a/docs/v1/SyntheticsParsingOptions.md b/docs/v1/SyntheticsParsingOptions.md index 2d97c2b5f7e6..24369f644e25 100644 --- a/docs/v1/SyntheticsParsingOptions.md +++ b/docs/v1/SyntheticsParsingOptions.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **field** | **String** | When type is `http_header`, name of the header to use to extract the value. | [optional] | -| **name** | **String** | Name of the variable to extract. | [optional] | -| **parser** | [**SyntheticsVariableParser**](SyntheticsVariableParser.md) | | [optional] | -| **type** | [**SyntheticsGlobalVariableParseTestOptionsType**](SyntheticsGlobalVariableParseTestOptionsType.md) | | [optional] | +| Name | Type | Description | Notes | +| ---------- | --------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ---------- | +| **field** | **String** | When type is `http_header`, name of the header to use to extract the value. | [optional] | +| **name** | **String** | Name of the variable to extract. | [optional] | +| **parser** | [**SyntheticsVariableParser**](SyntheticsVariableParser.md) | | [optional] | +| **type** | [**SyntheticsGlobalVariableParseTestOptionsType**](SyntheticsGlobalVariableParseTestOptionsType.md) | | [optional] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V1::SyntheticsParsingOptions.new( type: null ) ``` - diff --git a/docs/v1/SyntheticsPlayingTab.md b/docs/v1/SyntheticsPlayingTab.md index 8e2588880a8c..d737d9d24eb1 100644 --- a/docs/v1/SyntheticsPlayingTab.md +++ b/docs/v1/SyntheticsPlayingTab.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::SyntheticsPlayingTab.new() ``` - diff --git a/docs/v1/SyntheticsPrivateLocation.md b/docs/v1/SyntheticsPrivateLocation.md index ed49f6302245..966200f49328 100644 --- a/docs/v1/SyntheticsPrivateLocation.md +++ b/docs/v1/SyntheticsPrivateLocation.md @@ -2,13 +2,13 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **description** | **String** | Description of the private location. | | -| **id** | **String** | Unique identifier of the private location. | [optional][readonly] | -| **name** | **String** | Name of the private location. | | -| **secrets** | [**SyntheticsPrivateLocationSecrets**](SyntheticsPrivateLocationSecrets.md) | | [optional] | -| **tags** | **Array<String>** | Array of tags attached to the private location. | | +| Name | Type | Description | Notes | +| --------------- | --------------------------------------------------------------------------- | ----------------------------------------------- | -------------------- | +| **description** | **String** | Description of the private location. | | +| **id** | **String** | Unique identifier of the private location. | [optional][readonly] | +| **name** | **String** | Name of the private location. | | +| **secrets** | [**SyntheticsPrivateLocationSecrets**](SyntheticsPrivateLocationSecrets.md) | | [optional] | +| **tags** | **Array<String>** | Array of tags attached to the private location. | | ## Example @@ -23,4 +23,3 @@ instance = DatadogAPIClient::V1::SyntheticsPrivateLocation.new( tags: ["team:front"] ) ``` - diff --git a/docs/v1/SyntheticsPrivateLocationCreationResponse.md b/docs/v1/SyntheticsPrivateLocationCreationResponse.md index 8e4ba3356a4c..8572f5ca406e 100644 --- a/docs/v1/SyntheticsPrivateLocationCreationResponse.md +++ b/docs/v1/SyntheticsPrivateLocationCreationResponse.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **config** | **Object** | Configuration skeleton for the private location. See installation instructions of the private location on how to use this configuration. | [optional] | -| **private_location** | [**SyntheticsPrivateLocation**](SyntheticsPrivateLocation.md) | | [optional] | -| **result_encryption** | [**SyntheticsPrivateLocationCreationResponseResultEncryption**](SyntheticsPrivateLocationCreationResponseResultEncryption.md) | | [optional] | +| Name | Type | Description | Notes | +| --------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **config** | **Object** | Configuration skeleton for the private location. See installation instructions of the private location on how to use this configuration. | [optional] | +| **private_location** | [**SyntheticsPrivateLocation**](SyntheticsPrivateLocation.md) | | [optional] | +| **result_encryption** | [**SyntheticsPrivateLocationCreationResponseResultEncryption**](SyntheticsPrivateLocationCreationResponseResultEncryption.md) | | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::SyntheticsPrivateLocationCreationResponse.new( result_encryption: null ) ``` - diff --git a/docs/v1/SyntheticsPrivateLocationCreationResponseResultEncryption.md b/docs/v1/SyntheticsPrivateLocationCreationResponseResultEncryption.md index e15d769a826d..4e3a579ff36f 100644 --- a/docs/v1/SyntheticsPrivateLocationCreationResponseResultEncryption.md +++ b/docs/v1/SyntheticsPrivateLocationCreationResponseResultEncryption.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **id** | **String** | Fingerprint for the encryption key. | [optional] | -| **key** | **String** | Public key for result encryption. | [optional] | +| Name | Type | Description | Notes | +| ------- | ---------- | ----------------------------------- | ---------- | +| **id** | **String** | Fingerprint for the encryption key. | [optional] | +| **key** | **String** | Public key for result encryption. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::SyntheticsPrivateLocationCreationResponseResult key: null ) ``` - diff --git a/docs/v1/SyntheticsPrivateLocationSecrets.md b/docs/v1/SyntheticsPrivateLocationSecrets.md index 70d8d229e71d..c8100ef09468 100644 --- a/docs/v1/SyntheticsPrivateLocationSecrets.md +++ b/docs/v1/SyntheticsPrivateLocationSecrets.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **authentication** | [**SyntheticsPrivateLocationSecretsAuthentication**](SyntheticsPrivateLocationSecretsAuthentication.md) | | [optional] | -| **config_decryption** | [**SyntheticsPrivateLocationSecretsConfigDecryption**](SyntheticsPrivateLocationSecretsConfigDecryption.md) | | [optional] | +| Name | Type | Description | Notes | +| --------------------- | ----------------------------------------------------------------------------------------------------------- | ----------- | ---------- | +| **authentication** | [**SyntheticsPrivateLocationSecretsAuthentication**](SyntheticsPrivateLocationSecretsAuthentication.md) | | [optional] | +| **config_decryption** | [**SyntheticsPrivateLocationSecretsConfigDecryption**](SyntheticsPrivateLocationSecretsConfigDecryption.md) | | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::SyntheticsPrivateLocationSecrets.new( config_decryption: null ) ``` - diff --git a/docs/v1/SyntheticsPrivateLocationSecretsAuthentication.md b/docs/v1/SyntheticsPrivateLocationSecretsAuthentication.md index 80c75aa4abdc..5f9a4e998f3a 100644 --- a/docs/v1/SyntheticsPrivateLocationSecretsAuthentication.md +++ b/docs/v1/SyntheticsPrivateLocationSecretsAuthentication.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **id** | **String** | Access key for the private location. | [optional][readonly] | +| Name | Type | Description | Notes | +| ------- | ---------- | ------------------------------------------- | -------------------- | +| **id** | **String** | Access key for the private location. | [optional][readonly] | | **key** | **String** | Secret access key for the private location. | [optional][readonly] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::SyntheticsPrivateLocationSecretsAuthentication. key: null ) ``` - diff --git a/docs/v1/SyntheticsPrivateLocationSecretsConfigDecryption.md b/docs/v1/SyntheticsPrivateLocationSecretsConfigDecryption.md index 8f5ac7e5750b..cf7fb36dfc45 100644 --- a/docs/v1/SyntheticsPrivateLocationSecretsConfigDecryption.md +++ b/docs/v1/SyntheticsPrivateLocationSecretsConfigDecryption.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| ------- | ---------- | ------------------------------------- | -------------------- | | **key** | **String** | Private key for the private location. | [optional][readonly] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::SyntheticsPrivateLocationSecretsConfigDecryptio key: null ) ``` - diff --git a/docs/v1/SyntheticsSSLCertificate.md b/docs/v1/SyntheticsSSLCertificate.md index 1b47850e7808..2eb68d7ebdd6 100644 --- a/docs/v1/SyntheticsSSLCertificate.md +++ b/docs/v1/SyntheticsSSLCertificate.md @@ -2,20 +2,20 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **cipher** | **String** | Cipher used for the connection. | [optional] | -| **exponent** | **Float** | Exponent associated to the certificate. | [optional] | -| **ext_key_usage** | **Array<String>** | Array of extensions and details used for the certificate. | [optional] | -| **fingerprint** | **String** | MD5 digest of the DER-encoded Certificate information. | [optional] | -| **fingerprint256** | **String** | SHA-1 digest of the DER-encoded Certificate information. | [optional] | -| **issuer** | [**SyntheticsSSLCertificateIssuer**](SyntheticsSSLCertificateIssuer.md) | | [optional] | -| **modulus** | **String** | Modulus associated to the SSL certificate private key. | [optional] | -| **protocol** | **String** | TLS protocol used for the test. | [optional] | -| **serial_number** | **String** | Serial Number assigned by Symantec to the SSL certificate. | [optional] | -| **subject** | [**SyntheticsSSLCertificateSubject**](SyntheticsSSLCertificateSubject.md) | | [optional] | -| **valid_from** | **Time** | Date from which the SSL certificate is valid. | [optional] | -| **valid_to** | **Time** | Date until which the SSL certificate is valid. | [optional] | +| Name | Type | Description | Notes | +| ------------------ | ------------------------------------------------------------------------- | ---------------------------------------------------------- | ---------- | +| **cipher** | **String** | Cipher used for the connection. | [optional] | +| **exponent** | **Float** | Exponent associated to the certificate. | [optional] | +| **ext_key_usage** | **Array<String>** | Array of extensions and details used for the certificate. | [optional] | +| **fingerprint** | **String** | MD5 digest of the DER-encoded Certificate information. | [optional] | +| **fingerprint256** | **String** | SHA-1 digest of the DER-encoded Certificate information. | [optional] | +| **issuer** | [**SyntheticsSSLCertificateIssuer**](SyntheticsSSLCertificateIssuer.md) | | [optional] | +| **modulus** | **String** | Modulus associated to the SSL certificate private key. | [optional] | +| **protocol** | **String** | TLS protocol used for the test. | [optional] | +| **serial_number** | **String** | Serial Number assigned by Symantec to the SSL certificate. | [optional] | +| **subject** | [**SyntheticsSSLCertificateSubject**](SyntheticsSSLCertificateSubject.md) | | [optional] | +| **valid_from** | **Time** | Date from which the SSL certificate is valid. | [optional] | +| **valid_to** | **Time** | Date until which the SSL certificate is valid. | [optional] | ## Example @@ -37,4 +37,3 @@ instance = DatadogAPIClient::V1::SyntheticsSSLCertificate.new( valid_to: null ) ``` - diff --git a/docs/v1/SyntheticsSSLCertificateIssuer.md b/docs/v1/SyntheticsSSLCertificateIssuer.md index e77a321d1d20..423559406af9 100644 --- a/docs/v1/SyntheticsSSLCertificateIssuer.md +++ b/docs/v1/SyntheticsSSLCertificateIssuer.md @@ -2,13 +2,13 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **c** | **String** | Country Name that issued the certificate. | [optional] | -| **cn** | **String** | Common Name that issued certificate. | [optional] | -| **l** | **String** | Locality that issued the certificate. | [optional] | -| **o** | **String** | Organization that issued the certificate. | [optional] | -| **ou** | **String** | Organizational Unit that issued the certificate. | [optional] | +| Name | Type | Description | Notes | +| ------ | ---------- | --------------------------------------------------- | ---------- | +| **c** | **String** | Country Name that issued the certificate. | [optional] | +| **cn** | **String** | Common Name that issued certificate. | [optional] | +| **l** | **String** | Locality that issued the certificate. | [optional] | +| **o** | **String** | Organization that issued the certificate. | [optional] | +| **ou** | **String** | Organizational Unit that issued the certificate. | [optional] | | **st** | **String** | State Or Province Name that issued the certificate. | [optional] | ## Example @@ -25,4 +25,3 @@ instance = DatadogAPIClient::V1::SyntheticsSSLCertificateIssuer.new( st: null ) ``` - diff --git a/docs/v1/SyntheticsSSLCertificateSubject.md b/docs/v1/SyntheticsSSLCertificateSubject.md index 83998cabdd4f..b029d13724b3 100644 --- a/docs/v1/SyntheticsSSLCertificateSubject.md +++ b/docs/v1/SyntheticsSSLCertificateSubject.md @@ -2,14 +2,14 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **c** | **String** | Country Name associated with the certificate. | [optional] | -| **cn** | **String** | Common Name that associated with the certificate. | [optional] | -| **l** | **String** | Locality associated with the certificate. | [optional] | -| **o** | **String** | Organization associated with the certificate. | [optional] | -| **ou** | **String** | Organizational Unit associated with the certificate. | [optional] | -| **st** | **String** | State Or Province Name associated with the certificate. | [optional] | +| Name | Type | Description | Notes | +| ------------ | ---------- | --------------------------------------------------------- | ---------- | +| **c** | **String** | Country Name associated with the certificate. | [optional] | +| **cn** | **String** | Common Name that associated with the certificate. | [optional] | +| **l** | **String** | Locality associated with the certificate. | [optional] | +| **o** | **String** | Organization associated with the certificate. | [optional] | +| **ou** | **String** | Organizational Unit associated with the certificate. | [optional] | +| **st** | **String** | State Or Province Name associated with the certificate. | [optional] | | **alt_name** | **String** | Subject Alternative Name associated with the certificate. | [optional] | ## Example @@ -27,4 +27,3 @@ instance = DatadogAPIClient::V1::SyntheticsSSLCertificateSubject.new( alt_name: null ) ``` - diff --git a/docs/v1/SyntheticsStatus.md b/docs/v1/SyntheticsStatus.md index fa25630db4bb..ad586fcb3571 100644 --- a/docs/v1/SyntheticsStatus.md +++ b/docs/v1/SyntheticsStatus.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::SyntheticsStatus.new() ``` - diff --git a/docs/v1/SyntheticsStep.md b/docs/v1/SyntheticsStep.md index 9bf854a5b471..7da824f1237a 100644 --- a/docs/v1/SyntheticsStep.md +++ b/docs/v1/SyntheticsStep.md @@ -2,13 +2,13 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **allow_failure** | **Boolean** | A boolean set to allow this step to fail. | [optional] | -| **name** | **String** | The name of the step. | [optional] | -| **params** | **Object** | The parameters of the step. | [optional] | -| **timeout** | **Integer** | The time before declaring a step failed. | [optional] | -| **type** | [**SyntheticsStepType**](SyntheticsStepType.md) | | [optional] | +| Name | Type | Description | Notes | +| ----------------- | ----------------------------------------------- | ----------------------------------------- | ---------- | +| **allow_failure** | **Boolean** | A boolean set to allow this step to fail. | [optional] | +| **name** | **String** | The name of the step. | [optional] | +| **params** | **Object** | The parameters of the step. | [optional] | +| **timeout** | **Integer** | The time before declaring a step failed. | [optional] | +| **type** | [**SyntheticsStepType**](SyntheticsStepType.md) | | [optional] | ## Example @@ -23,4 +23,3 @@ instance = DatadogAPIClient::V1::SyntheticsStep.new( type: null ) ``` - diff --git a/docs/v1/SyntheticsStepDetail.md b/docs/v1/SyntheticsStepDetail.md index 706380125b9e..cd2887f9a415 100644 --- a/docs/v1/SyntheticsStepDetail.md +++ b/docs/v1/SyntheticsStepDetail.md @@ -2,25 +2,25 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **browser_errors** | [**Array<SyntheticsBrowserError>**](SyntheticsBrowserError.md) | Array of errors collected for a browser test. | [optional] | -| **check_type** | [**SyntheticsCheckType**](SyntheticsCheckType.md) | | [optional] | -| **description** | **String** | Description of the test. | [optional] | -| **duration** | **Float** | Total duration in millisecond of the test. | [optional] | -| **error** | **String** | Error returned by the test. | [optional] | -| **playing_tab** | [**SyntheticsPlayingTab**](SyntheticsPlayingTab.md) | | [optional] | -| **screenshot_bucket_key** | **Boolean** | Whether or not screenshots where collected by the test. | [optional] | -| **skipped** | **Boolean** | Whether or not to skip this step. | [optional] | -| **snapshot_bucket_key** | **Boolean** | Whether or not snapshots where collected by the test. | [optional] | -| **step_id** | **Integer** | The step ID. | [optional] | -| **sub_test_step_details** | [**Array<SyntheticsStepDetail>**](SyntheticsStepDetail.md) | If this steps include a sub-test. [Subtests documentation](https://docs.datadoghq.com/synthetics/browser_tests/advanced_options/#subtests). | [optional] | -| **time_to_interactive** | **Float** | Time before starting the step. | [optional] | -| **type** | [**SyntheticsStepType**](SyntheticsStepType.md) | | [optional] | -| **url** | **String** | URL to perform the step against. | [optional] | -| **value** | **Object** | Value for the step. | [optional] | -| **vitals_metrics** | [**Array<SyntheticsCoreWebVitals>**](SyntheticsCoreWebVitals.md) | Array of Core Web Vitals metrics for the step. | [optional] | -| **warnings** | [**Array<SyntheticsStepDetailWarning>**](SyntheticsStepDetailWarning.md) | Warning collected that didn't failed the step. | [optional] | +| Name | Type | Description | Notes | +| ------------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **browser_errors** | [**Array<SyntheticsBrowserError>**](SyntheticsBrowserError.md) | Array of errors collected for a browser test. | [optional] | +| **check_type** | [**SyntheticsCheckType**](SyntheticsCheckType.md) | | [optional] | +| **description** | **String** | Description of the test. | [optional] | +| **duration** | **Float** | Total duration in millisecond of the test. | [optional] | +| **error** | **String** | Error returned by the test. | [optional] | +| **playing_tab** | [**SyntheticsPlayingTab**](SyntheticsPlayingTab.md) | | [optional] | +| **screenshot_bucket_key** | **Boolean** | Whether or not screenshots where collected by the test. | [optional] | +| **skipped** | **Boolean** | Whether or not to skip this step. | [optional] | +| **snapshot_bucket_key** | **Boolean** | Whether or not snapshots where collected by the test. | [optional] | +| **step_id** | **Integer** | The step ID. | [optional] | +| **sub_test_step_details** | [**Array<SyntheticsStepDetail>**](SyntheticsStepDetail.md) | If this steps include a sub-test. [Subtests documentation](https://docs.datadoghq.com/synthetics/browser_tests/advanced_options/#subtests). | [optional] | +| **time_to_interactive** | **Float** | Time before starting the step. | [optional] | +| **type** | [**SyntheticsStepType**](SyntheticsStepType.md) | | [optional] | +| **url** | **String** | URL to perform the step against. | [optional] | +| **value** | **Object** | Value for the step. | [optional] | +| **vitals_metrics** | [**Array<SyntheticsCoreWebVitals>**](SyntheticsCoreWebVitals.md) | Array of Core Web Vitals metrics for the step. | [optional] | +| **warnings** | [**Array<SyntheticsStepDetailWarning>**](SyntheticsStepDetailWarning.md) | Warning collected that didn't failed the step. | [optional] | ## Example @@ -47,4 +47,3 @@ instance = DatadogAPIClient::V1::SyntheticsStepDetail.new( warnings: null ) ``` - diff --git a/docs/v1/SyntheticsStepDetailWarning.md b/docs/v1/SyntheticsStepDetailWarning.md index 7579529ce8ce..531b90ddfb3a 100644 --- a/docs/v1/SyntheticsStepDetailWarning.md +++ b/docs/v1/SyntheticsStepDetailWarning.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **message** | **String** | Message for the warning. | | -| **type** | [**SyntheticsWarningType**](SyntheticsWarningType.md) | | | +| Name | Type | Description | Notes | +| ----------- | ----------------------------------------------------- | ------------------------ | ----- | +| **message** | **String** | Message for the warning. | | +| **type** | [**SyntheticsWarningType**](SyntheticsWarningType.md) | | | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::SyntheticsStepDetailWarning.new( type: null ) ``` - diff --git a/docs/v1/SyntheticsStepType.md b/docs/v1/SyntheticsStepType.md index 00a9f1f85772..3fcd4ea7e10e 100644 --- a/docs/v1/SyntheticsStepType.md +++ b/docs/v1/SyntheticsStepType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::SyntheticsStepType.new() ``` - diff --git a/docs/v1/SyntheticsTestConfig.md b/docs/v1/SyntheticsTestConfig.md index 1965530e8f32..9034a8a7d624 100644 --- a/docs/v1/SyntheticsTestConfig.md +++ b/docs/v1/SyntheticsTestConfig.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **assertions** | [**Array<SyntheticsAssertion>**](SyntheticsAssertion.md) | Array of assertions used for the test. | [optional] | -| **config_variables** | [**Array<SyntheticsConfigVariable>**](SyntheticsConfigVariable.md) | Array of variables used for the test. | [optional] | -| **request** | [**SyntheticsTestRequest**](SyntheticsTestRequest.md) | | [optional] | -| **variables** | [**Array<SyntheticsBrowserVariable>**](SyntheticsBrowserVariable.md) | Browser tests only - array of variables used for the test steps. | [optional] | +| Name | Type | Description | Notes | +| -------------------- | -------------------------------------------------------------------------- | ---------------------------------------------------------------- | ---------- | +| **assertions** | [**Array<SyntheticsAssertion>**](SyntheticsAssertion.md) | Array of assertions used for the test. | [optional] | +| **config_variables** | [**Array<SyntheticsConfigVariable>**](SyntheticsConfigVariable.md) | Array of variables used for the test. | [optional] | +| **request** | [**SyntheticsTestRequest**](SyntheticsTestRequest.md) | | [optional] | +| **variables** | [**Array<SyntheticsBrowserVariable>**](SyntheticsBrowserVariable.md) | Browser tests only - array of variables used for the test steps. | [optional] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V1::SyntheticsTestConfig.new( variables: null ) ``` - diff --git a/docs/v1/SyntheticsTestDetails.md b/docs/v1/SyntheticsTestDetails.md index 12e6f7f5779e..ba34f96cd4eb 100644 --- a/docs/v1/SyntheticsTestDetails.md +++ b/docs/v1/SyntheticsTestDetails.md @@ -2,21 +2,21 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **config** | [**SyntheticsTestConfig**](SyntheticsTestConfig.md) | | [optional] | -| **creator** | [**Creator**](Creator.md) | | [optional] | -| **locations** | **Array<String>** | Array of locations used to run the test. | [optional] | -| **message** | **String** | Notification message associated with the test. | [optional] | -| **monitor_id** | **Integer** | The associated monitor ID. | [optional][readonly] | -| **name** | **String** | Name of the test. | [optional] | -| **options** | [**SyntheticsTestOptions**](SyntheticsTestOptions.md) | | [optional] | -| **public_id** | **String** | The test public ID. | [optional][readonly] | -| **status** | [**SyntheticsTestPauseStatus**](SyntheticsTestPauseStatus.md) | | [optional] | -| **steps** | [**Array<SyntheticsStep>**](SyntheticsStep.md) | For browser test, the steps of the test. | [optional] | -| **subtype** | [**SyntheticsTestDetailsSubType**](SyntheticsTestDetailsSubType.md) | | [optional] | -| **tags** | **Array<String>** | Array of tags attached to the test. | [optional] | -| **type** | [**SyntheticsTestDetailsType**](SyntheticsTestDetailsType.md) | | [optional] | +| Name | Type | Description | Notes | +| -------------- | ------------------------------------------------------------------- | ---------------------------------------------- | -------------------- | +| **config** | [**SyntheticsTestConfig**](SyntheticsTestConfig.md) | | [optional] | +| **creator** | [**Creator**](Creator.md) | | [optional] | +| **locations** | **Array<String>** | Array of locations used to run the test. | [optional] | +| **message** | **String** | Notification message associated with the test. | [optional] | +| **monitor_id** | **Integer** | The associated monitor ID. | [optional][readonly] | +| **name** | **String** | Name of the test. | [optional] | +| **options** | [**SyntheticsTestOptions**](SyntheticsTestOptions.md) | | [optional] | +| **public_id** | **String** | The test public ID. | [optional][readonly] | +| **status** | [**SyntheticsTestPauseStatus**](SyntheticsTestPauseStatus.md) | | [optional] | +| **steps** | [**Array<SyntheticsStep>**](SyntheticsStep.md) | For browser test, the steps of the test. | [optional] | +| **subtype** | [**SyntheticsTestDetailsSubType**](SyntheticsTestDetailsSubType.md) | | [optional] | +| **tags** | **Array<String>** | Array of tags attached to the test. | [optional] | +| **type** | [**SyntheticsTestDetailsType**](SyntheticsTestDetailsType.md) | | [optional] | ## Example @@ -39,4 +39,3 @@ instance = DatadogAPIClient::V1::SyntheticsTestDetails.new( type: null ) ``` - diff --git a/docs/v1/SyntheticsTestDetailsSubType.md b/docs/v1/SyntheticsTestDetailsSubType.md index 47006e653a69..c967405c3b76 100644 --- a/docs/v1/SyntheticsTestDetailsSubType.md +++ b/docs/v1/SyntheticsTestDetailsSubType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::SyntheticsTestDetailsSubType.new() ``` - diff --git a/docs/v1/SyntheticsTestDetailsType.md b/docs/v1/SyntheticsTestDetailsType.md index 0b0fae72d84b..3b1df1fe56e4 100644 --- a/docs/v1/SyntheticsTestDetailsType.md +++ b/docs/v1/SyntheticsTestDetailsType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::SyntheticsTestDetailsType.new() ``` - diff --git a/docs/v1/SyntheticsTestExecutionRule.md b/docs/v1/SyntheticsTestExecutionRule.md index c3709ef8b087..4b4418b069b5 100644 --- a/docs/v1/SyntheticsTestExecutionRule.md +++ b/docs/v1/SyntheticsTestExecutionRule.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::SyntheticsTestExecutionRule.new() ``` - diff --git a/docs/v1/SyntheticsTestMonitorStatus.md b/docs/v1/SyntheticsTestMonitorStatus.md index 5934bfa91a1a..97f67083a1c5 100644 --- a/docs/v1/SyntheticsTestMonitorStatus.md +++ b/docs/v1/SyntheticsTestMonitorStatus.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::SyntheticsTestMonitorStatus.new() ``` - diff --git a/docs/v1/SyntheticsTestOptions.md b/docs/v1/SyntheticsTestOptions.md index bd9cade957fe..4983d5702999 100644 --- a/docs/v1/SyntheticsTestOptions.md +++ b/docs/v1/SyntheticsTestOptions.md @@ -2,21 +2,21 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **accept_self_signed** | **Boolean** | For SSL test, whether or not the test should allow self signed certificates. | [optional] | -| **allow_insecure** | **Boolean** | Allows loading insecure content for an HTTP request. | [optional] | -| **device_ids** | [**Array<SyntheticsDeviceID>**](SyntheticsDeviceID.md) | For browser test, array with the different device IDs used to run the test. | [optional] | -| **disable_cors** | **Boolean** | Whether or not to disable CORS mechanism. | [optional] | -| **follow_redirects** | **Boolean** | For API HTTP test, whether or not the test should follow redirects. | [optional] | -| **min_failure_duration** | **Integer** | Minimum amount of time in failure required to trigger an alert. | [optional] | -| **min_location_failed** | **Integer** | Minimum number of locations in failure required to trigger an alert. | [optional] | -| **monitor_name** | **String** | The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs. | [optional] | -| **monitor_options** | [**SyntheticsTestOptionsMonitorOptions**](SyntheticsTestOptionsMonitorOptions.md) | | [optional] | -| **monitor_priority** | **Integer** | Integer from 1 (high) to 5 (low) indicating alert severity. | [optional] | -| **no_screenshot** | **Boolean** | Prevents saving screenshots of the steps. | [optional] | -| **_retry** | [**SyntheticsTestOptionsRetry**](SyntheticsTestOptionsRetry.md) | | [optional] | -| **tick_every** | **Integer** | The frequency at which to run the Synthetic test (in seconds). | [optional] | +| Name | Type | Description | Notes | +| ------------------------ | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | ---------- | +| **accept_self_signed** | **Boolean** | For SSL test, whether or not the test should allow self signed certificates. | [optional] | +| **allow_insecure** | **Boolean** | Allows loading insecure content for an HTTP request. | [optional] | +| **device_ids** | [**Array<SyntheticsDeviceID>**](SyntheticsDeviceID.md) | For browser test, array with the different device IDs used to run the test. | [optional] | +| **disable_cors** | **Boolean** | Whether or not to disable CORS mechanism. | [optional] | +| **follow_redirects** | **Boolean** | For API HTTP test, whether or not the test should follow redirects. | [optional] | +| **min_failure_duration** | **Integer** | Minimum amount of time in failure required to trigger an alert. | [optional] | +| **min_location_failed** | **Integer** | Minimum number of locations in failure required to trigger an alert. | [optional] | +| **monitor_name** | **String** | The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs. | [optional] | +| **monitor_options** | [**SyntheticsTestOptionsMonitorOptions**](SyntheticsTestOptionsMonitorOptions.md) | | [optional] | +| **monitor_priority** | **Integer** | Integer from 1 (high) to 5 (low) indicating alert severity. | [optional] | +| **no_screenshot** | **Boolean** | Prevents saving screenshots of the steps. | [optional] | +| **\_retry** | [**SyntheticsTestOptionsRetry**](SyntheticsTestOptionsRetry.md) | | [optional] | +| **tick_every** | **Integer** | The frequency at which to run the Synthetic test (in seconds). | [optional] | ## Example @@ -39,4 +39,3 @@ instance = DatadogAPIClient::V1::SyntheticsTestOptions.new( tick_every: null ) ``` - diff --git a/docs/v1/SyntheticsTestOptionsMonitorOptions.md b/docs/v1/SyntheticsTestOptionsMonitorOptions.md index 59bfb3ed758a..c2f8ebb99742 100644 --- a/docs/v1/SyntheticsTestOptionsMonitorOptions.md +++ b/docs/v1/SyntheticsTestOptionsMonitorOptions.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| --------------------- | ----------- | --------------------------------------------------------------------------- | ---------- | | **renotify_interval** | **Integer** | Time interval before renotifying if the test is still failing (in minutes). | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::SyntheticsTestOptionsMonitorOptions.new( renotify_interval: null ) ``` - diff --git a/docs/v1/SyntheticsTestOptionsRetry.md b/docs/v1/SyntheticsTestOptionsRetry.md index 76b8d08a0a9e..499fb20bd63e 100644 --- a/docs/v1/SyntheticsTestOptionsRetry.md +++ b/docs/v1/SyntheticsTestOptionsRetry.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **count** | **Integer** | Number of times a test needs to be retried before marking a location as failed. Defaults to 0. | [optional] | -| **interval** | **Float** | Time interval between retries (in milliseconds). Defaults to 300ms. | [optional] | +| Name | Type | Description | Notes | +| ------------ | ----------- | ---------------------------------------------------------------------------------------------- | ---------- | +| **count** | **Integer** | Number of times a test needs to be retried before marking a location as failed. Defaults to 0. | [optional] | +| **interval** | **Float** | Time interval between retries (in milliseconds). Defaults to 300ms. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::SyntheticsTestOptionsRetry.new( interval: null ) ``` - diff --git a/docs/v1/SyntheticsTestPauseStatus.md b/docs/v1/SyntheticsTestPauseStatus.md index bf5de10390cc..6d0fb734d9b6 100644 --- a/docs/v1/SyntheticsTestPauseStatus.md +++ b/docs/v1/SyntheticsTestPauseStatus.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::SyntheticsTestPauseStatus.new() ``` - diff --git a/docs/v1/SyntheticsTestProcessStatus.md b/docs/v1/SyntheticsTestProcessStatus.md index bc8a5b779395..8823d80f8e2e 100644 --- a/docs/v1/SyntheticsTestProcessStatus.md +++ b/docs/v1/SyntheticsTestProcessStatus.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::SyntheticsTestProcessStatus.new() ``` - diff --git a/docs/v1/SyntheticsTestRequest.md b/docs/v1/SyntheticsTestRequest.md index 243919515670..045ed7bea78c 100644 --- a/docs/v1/SyntheticsTestRequest.md +++ b/docs/v1/SyntheticsTestRequest.md @@ -2,26 +2,26 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **allow_insecure** | **Boolean** | Allows loading insecure content for an HTTP request in a multistep test step. | [optional] | -| **basic_auth** | [**SyntheticsBasicAuth**](SyntheticsBasicAuth.md) | | [optional] | -| **body** | **String** | Body to include in the test. | [optional] | -| **certificate** | [**SyntheticsTestRequestCertificate**](SyntheticsTestRequestCertificate.md) | | [optional] | -| **dns_server** | **String** | DNS server to use for DNS tests. | [optional] | -| **dns_server_port** | **Integer** | DNS server port to use for DNS tests. | [optional] | -| **follow_redirects** | **Boolean** | Specifies whether or not the request follows redirects. | [optional] | -| **headers** | **Hash<String, String>** | Headers to include when performing the test. | [optional] | -| **host** | **String** | Host name to perform the test with. | [optional] | -| **method** | [**HTTPMethod**](HTTPMethod.md) | | [optional] | -| **no_saving_response_body** | **Boolean** | Determines whether or not to save the response body. | [optional] | -| **number_of_packets** | **Integer** | Number of pings to use per test. | [optional] | -| **port** | **Integer** | Port to use when performing the test. | [optional] | -| **query** | **Object** | Query to use for the test. | [optional] | -| **servername** | **String** | For SSL tests, it specifies on which server you want to initiate the TLS handshake, allowing the server to present one of multiple possible certificates on the same IP address and TCP port number. | [optional] | -| **should_track_hops** | **Boolean** | Turns on a traceroute probe to discover all gateways along the path to the host destination. | [optional] | -| **timeout** | **Float** | Timeout in seconds for the test. | [optional] | -| **url** | **String** | URL to perform the test with. | [optional] | +| Name | Type | Description | Notes | +| --------------------------- | --------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **allow_insecure** | **Boolean** | Allows loading insecure content for an HTTP request in a multistep test step. | [optional] | +| **basic_auth** | [**SyntheticsBasicAuth**](SyntheticsBasicAuth.md) | | [optional] | +| **body** | **String** | Body to include in the test. | [optional] | +| **certificate** | [**SyntheticsTestRequestCertificate**](SyntheticsTestRequestCertificate.md) | | [optional] | +| **dns_server** | **String** | DNS server to use for DNS tests. | [optional] | +| **dns_server_port** | **Integer** | DNS server port to use for DNS tests. | [optional] | +| **follow_redirects** | **Boolean** | Specifies whether or not the request follows redirects. | [optional] | +| **headers** | **Hash<String, String>** | Headers to include when performing the test. | [optional] | +| **host** | **String** | Host name to perform the test with. | [optional] | +| **method** | [**HTTPMethod**](HTTPMethod.md) | | [optional] | +| **no_saving_response_body** | **Boolean** | Determines whether or not to save the response body. | [optional] | +| **number_of_packets** | **Integer** | Number of pings to use per test. | [optional] | +| **port** | **Integer** | Port to use when performing the test. | [optional] | +| **query** | **Object** | Query to use for the test. | [optional] | +| **servername** | **String** | For SSL tests, it specifies on which server you want to initiate the TLS handshake, allowing the server to present one of multiple possible certificates on the same IP address and TCP port number. | [optional] | +| **should_track_hops** | **Boolean** | Turns on a traceroute probe to discover all gateways along the path to the host destination. | [optional] | +| **timeout** | **Float** | Timeout in seconds for the test. | [optional] | +| **url** | **String** | URL to perform the test with. | [optional] | ## Example @@ -49,4 +49,3 @@ instance = DatadogAPIClient::V1::SyntheticsTestRequest.new( url: https://example.com ) ``` - diff --git a/docs/v1/SyntheticsTestRequestCertificate.md b/docs/v1/SyntheticsTestRequestCertificate.md index 4e1113171445..7d0d679d0213 100644 --- a/docs/v1/SyntheticsTestRequestCertificate.md +++ b/docs/v1/SyntheticsTestRequestCertificate.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **cert** | [**SyntheticsTestRequestCertificateItem**](SyntheticsTestRequestCertificateItem.md) | | [optional] | -| **key** | [**SyntheticsTestRequestCertificateItem**](SyntheticsTestRequestCertificateItem.md) | | [optional] | +| Name | Type | Description | Notes | +| -------- | ----------------------------------------------------------------------------------- | ----------- | ---------- | +| **cert** | [**SyntheticsTestRequestCertificateItem**](SyntheticsTestRequestCertificateItem.md) | | [optional] | +| **key** | [**SyntheticsTestRequestCertificateItem**](SyntheticsTestRequestCertificateItem.md) | | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::SyntheticsTestRequestCertificate.new( key: null ) ``` - diff --git a/docs/v1/SyntheticsTestRequestCertificateItem.md b/docs/v1/SyntheticsTestRequestCertificateItem.md index 0b081faa5a78..a1b656879ae1 100644 --- a/docs/v1/SyntheticsTestRequestCertificateItem.md +++ b/docs/v1/SyntheticsTestRequestCertificateItem.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **content** | **String** | Content of the certificate or key. | [optional] | -| **filename** | **String** | File name for the certificate or key. | [optional] | +| Name | Type | Description | Notes | +| -------------- | ---------- | ----------------------------------------------------- | ---------- | +| **content** | **String** | Content of the certificate or key. | [optional] | +| **filename** | **String** | File name for the certificate or key. | [optional] | | **updated_at** | **String** | Date of update of the certificate or key, ISO format. | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::SyntheticsTestRequestCertificateItem.new( updated_at: null ) ``` - diff --git a/docs/v1/SyntheticsTiming.md b/docs/v1/SyntheticsTiming.md index 4bd387e605c0..20f1a84e6356 100644 --- a/docs/v1/SyntheticsTiming.md +++ b/docs/v1/SyntheticsTiming.md @@ -2,17 +2,17 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **dns** | **Float** | The duration in millisecond of the DNS lookup. | [optional] | -| **download** | **Float** | The time in millisecond to download the response. | [optional] | -| **first_byte** | **Float** | The time in millisecond to first byte. | [optional] | -| **handshake** | **Float** | The duration in millisecond of the TLS handshake. | [optional] | -| **redirect** | **Float** | The time in millisecond spent during redirections. | [optional] | -| **ssl** | **Float** | The duration in millisecond of the TLS handshake. | [optional] | -| **tcp** | **Float** | Time in millisecond to establish the TCP connection. | [optional] | -| **total** | **Float** | The overall time in millisecond the request took to be processed. | [optional] | -| **wait** | **Float** | Time spent in millisecond waiting for a response. | [optional] | +| Name | Type | Description | Notes | +| -------------- | --------- | ----------------------------------------------------------------- | ---------- | +| **dns** | **Float** | The duration in millisecond of the DNS lookup. | [optional] | +| **download** | **Float** | The time in millisecond to download the response. | [optional] | +| **first_byte** | **Float** | The time in millisecond to first byte. | [optional] | +| **handshake** | **Float** | The duration in millisecond of the TLS handshake. | [optional] | +| **redirect** | **Float** | The time in millisecond spent during redirections. | [optional] | +| **ssl** | **Float** | The duration in millisecond of the TLS handshake. | [optional] | +| **tcp** | **Float** | Time in millisecond to establish the TCP connection. | [optional] | +| **total** | **Float** | The overall time in millisecond the request took to be processed. | [optional] | +| **wait** | **Float** | Time spent in millisecond waiting for a response. | [optional] | ## Example @@ -31,4 +31,3 @@ instance = DatadogAPIClient::V1::SyntheticsTiming.new( wait: null ) ``` - diff --git a/docs/v1/SyntheticsTriggerCITestLocation.md b/docs/v1/SyntheticsTriggerCITestLocation.md index 6d1649827794..1337b88b142d 100644 --- a/docs/v1/SyntheticsTriggerCITestLocation.md +++ b/docs/v1/SyntheticsTriggerCITestLocation.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **id** | **Integer** | Unique identifier of the location. | [optional] | -| **name** | **String** | Name of the location. | [optional] | +| Name | Type | Description | Notes | +| -------- | ----------- | ---------------------------------- | ---------- | +| **id** | **Integer** | Unique identifier of the location. | [optional] | +| **name** | **String** | Name of the location. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::SyntheticsTriggerCITestLocation.new( name: null ) ``` - diff --git a/docs/v1/SyntheticsTriggerCITestRunResult.md b/docs/v1/SyntheticsTriggerCITestRunResult.md index c72089bf3682..6684bfb60f3a 100644 --- a/docs/v1/SyntheticsTriggerCITestRunResult.md +++ b/docs/v1/SyntheticsTriggerCITestRunResult.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **device** | [**SyntheticsDeviceID**](SyntheticsDeviceID.md) | | [optional] | -| **location** | **Integer** | The location ID of the test run. | [optional] | -| **public_id** | **String** | The public ID of the Synthetics test. | [optional] | -| **result_id** | **String** | ID of the result. | [optional] | +| Name | Type | Description | Notes | +| ------------- | ----------------------------------------------- | ------------------------------------- | ---------- | +| **device** | [**SyntheticsDeviceID**](SyntheticsDeviceID.md) | | [optional] | +| **location** | **Integer** | The location ID of the test run. | [optional] | +| **public_id** | **String** | The public ID of the Synthetics test. | [optional] | +| **result_id** | **String** | ID of the result. | [optional] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V1::SyntheticsTriggerCITestRunResult.new( result_id: null ) ``` - diff --git a/docs/v1/SyntheticsTriggerCITestsResponse.md b/docs/v1/SyntheticsTriggerCITestsResponse.md index ffac32e4cde8..826bc6638653 100644 --- a/docs/v1/SyntheticsTriggerCITestsResponse.md +++ b/docs/v1/SyntheticsTriggerCITestsResponse.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **batch_id** | **String** | The public ID of the batch triggered. | [optional] | -| **locations** | [**Array<SyntheticsTriggerCITestLocation>**](SyntheticsTriggerCITestLocation.md) | List of Synthetics locations. | [optional] | -| **results** | [**Array<SyntheticsTriggerCITestRunResult>**](SyntheticsTriggerCITestRunResult.md) | Information about the tests runs. | [optional] | -| **triggered_check_ids** | **Array<String>** | The public IDs of the Synthetics test triggered. | [optional] | +| Name | Type | Description | Notes | +| ----------------------- | ---------------------------------------------------------------------------------------- | ------------------------------------------------ | ---------- | +| **batch_id** | **String** | The public ID of the batch triggered. | [optional] | +| **locations** | [**Array<SyntheticsTriggerCITestLocation>**](SyntheticsTriggerCITestLocation.md) | List of Synthetics locations. | [optional] | +| **results** | [**Array<SyntheticsTriggerCITestRunResult>**](SyntheticsTriggerCITestRunResult.md) | Information about the tests runs. | [optional] | +| **triggered_check_ids** | **Array<String>** | The public IDs of the Synthetics test triggered. | [optional] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V1::SyntheticsTriggerCITestsResponse.new( triggered_check_ids: null ) ``` - diff --git a/docs/v1/SyntheticsUpdateTestPauseStatusPayload.md b/docs/v1/SyntheticsUpdateTestPauseStatusPayload.md index 30afc5bfd19e..d5bb1e92c692 100644 --- a/docs/v1/SyntheticsUpdateTestPauseStatusPayload.md +++ b/docs/v1/SyntheticsUpdateTestPauseStatusPayload.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **new_status** | [**SyntheticsTestPauseStatus**](SyntheticsTestPauseStatus.md) | | [optional] | +| Name | Type | Description | Notes | +| -------------- | ------------------------------------------------------------- | ----------- | ---------- | +| **new_status** | [**SyntheticsTestPauseStatus**](SyntheticsTestPauseStatus.md) | | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::SyntheticsUpdateTestPauseStatusPayload.new( new_status: null ) ``` - diff --git a/docs/v1/SyntheticsVariableParser.md b/docs/v1/SyntheticsVariableParser.md index a7bcf8119119..35775d820ee4 100644 --- a/docs/v1/SyntheticsVariableParser.md +++ b/docs/v1/SyntheticsVariableParser.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **type** | [**SyntheticsGlobalVariableParserType**](SyntheticsGlobalVariableParserType.md) | | | -| **value** | **String** | Regex or JSON path used for the parser. Not used with type `raw`. | [optional] | +| Name | Type | Description | Notes | +| --------- | ------------------------------------------------------------------------------- | --------------------------------------------------------------------------- | ---------- | +| **type** | [**SyntheticsGlobalVariableParserType**](SyntheticsGlobalVariableParserType.md) | | | +| **value** | **String** | Regex or JSON path used for the parser. Not used with type `raw`. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::SyntheticsVariableParser.new( value: null ) ``` - diff --git a/docs/v1/SyntheticsWarningType.md b/docs/v1/SyntheticsWarningType.md index 1a3e78eed3f1..701d7fefa837 100644 --- a/docs/v1/SyntheticsWarningType.md +++ b/docs/v1/SyntheticsWarningType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::SyntheticsWarningType.new() ``` - diff --git a/docs/v1/TableWidgetCellDisplayMode.md b/docs/v1/TableWidgetCellDisplayMode.md index 017815c0d8b6..9e12e3e2b57e 100644 --- a/docs/v1/TableWidgetCellDisplayMode.md +++ b/docs/v1/TableWidgetCellDisplayMode.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::TableWidgetCellDisplayMode.new() ``` - diff --git a/docs/v1/TableWidgetDefinition.md b/docs/v1/TableWidgetDefinition.md index d6e63c79e89a..bcb429e9e655 100644 --- a/docs/v1/TableWidgetDefinition.md +++ b/docs/v1/TableWidgetDefinition.md @@ -2,16 +2,16 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **custom_links** | [**Array<WidgetCustomLink>**](WidgetCustomLink.md) | List of custom links. | [optional] | -| **has_search_bar** | [**TableWidgetHasSearchBar**](TableWidgetHasSearchBar.md) | | [optional] | -| **requests** | [**Array<TableWidgetRequest>**](TableWidgetRequest.md) | Widget definition. | | -| **time** | [**WidgetTime**](WidgetTime.md) | | [optional] | -| **title** | **String** | Title of your widget. | [optional] | -| **title_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | -| **title_size** | **String** | Size of the title. | [optional] | -| **type** | [**TableWidgetDefinitionType**](TableWidgetDefinitionType.md) | | [default to 'query_table'] | +| Name | Type | Description | Notes | +| ------------------ | ------------------------------------------------------------- | --------------------- | ---------------------------------- | +| **custom_links** | [**Array<WidgetCustomLink>**](WidgetCustomLink.md) | List of custom links. | [optional] | +| **has_search_bar** | [**TableWidgetHasSearchBar**](TableWidgetHasSearchBar.md) | | [optional] | +| **requests** | [**Array<TableWidgetRequest>**](TableWidgetRequest.md) | Widget definition. | | +| **time** | [**WidgetTime**](WidgetTime.md) | | [optional] | +| **title** | **String** | Title of your widget. | [optional] | +| **title_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | +| **title_size** | **String** | Size of the title. | [optional] | +| **type** | [**TableWidgetDefinitionType**](TableWidgetDefinitionType.md) | | [default to 'query_table'] | ## Example @@ -29,4 +29,3 @@ instance = DatadogAPIClient::V1::TableWidgetDefinition.new( type: null ) ``` - diff --git a/docs/v1/TableWidgetDefinitionType.md b/docs/v1/TableWidgetDefinitionType.md index f56841663ff1..e434dfa29927 100644 --- a/docs/v1/TableWidgetDefinitionType.md +++ b/docs/v1/TableWidgetDefinitionType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::TableWidgetDefinitionType.new() ``` - diff --git a/docs/v1/TableWidgetHasSearchBar.md b/docs/v1/TableWidgetHasSearchBar.md index 71da4ce56dde..5c014380b022 100644 --- a/docs/v1/TableWidgetHasSearchBar.md +++ b/docs/v1/TableWidgetHasSearchBar.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::TableWidgetHasSearchBar.new() ``` - diff --git a/docs/v1/TableWidgetRequest.md b/docs/v1/TableWidgetRequest.md index 5d0bc1ca594c..cb6a5629126a 100644 --- a/docs/v1/TableWidgetRequest.md +++ b/docs/v1/TableWidgetRequest.md @@ -2,27 +2,27 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **aggregator** | [**WidgetAggregator**](WidgetAggregator.md) | | [optional] | -| **_alias** | **String** | The column name (defaults to the metric name). | [optional] | -| **apm_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **apm_stats_query** | [**ApmStatsQueryDefinition**](ApmStatsQueryDefinition.md) | | [optional] | -| **cell_display_mode** | [**Array<TableWidgetCellDisplayMode>**](TableWidgetCellDisplayMode.md) | A list of display modes for each table cell. | [optional] | -| **conditional_formats** | [**Array<WidgetConditionalFormat>**](WidgetConditionalFormat.md) | List of conditional formats. | [optional] | -| **event_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **formulas** | [**Array<WidgetFormula>**](WidgetFormula.md) | List of formulas that operate on queries. **This feature is currently in beta.** | [optional] | -| **limit** | **Integer** | For metric queries, the number of lines to show in the table. Only one request should have this property. | [optional] | -| **log_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **network_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **order** | [**WidgetSort**](WidgetSort.md) | | [optional] | -| **process_query** | [**ProcessQueryDefinition**](ProcessQueryDefinition.md) | | [optional] | -| **profile_metrics_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **q** | **String** | Query definition. | [optional] | -| **queries** | [**Array<FormulaAndFunctionQueryDefinition>**](FormulaAndFunctionQueryDefinition.md) | List of queries that can be returned directly or used in formulas. **This feature is currently in beta.** | [optional] | -| **response_format** | [**FormulaAndFunctionResponseFormat**](FormulaAndFunctionResponseFormat.md) | | [optional] | -| **rum_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **security_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| Name | Type | Description | Notes | +| ------------------------- | ------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------- | ---------- | +| **aggregator** | [**WidgetAggregator**](WidgetAggregator.md) | | [optional] | +| **\_alias** | **String** | The column name (defaults to the metric name). | [optional] | +| **apm_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **apm_stats_query** | [**ApmStatsQueryDefinition**](ApmStatsQueryDefinition.md) | | [optional] | +| **cell_display_mode** | [**Array<TableWidgetCellDisplayMode>**](TableWidgetCellDisplayMode.md) | A list of display modes for each table cell. | [optional] | +| **conditional_formats** | [**Array<WidgetConditionalFormat>**](WidgetConditionalFormat.md) | List of conditional formats. | [optional] | +| **event_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **formulas** | [**Array<WidgetFormula>**](WidgetFormula.md) | List of formulas that operate on queries. **This feature is currently in beta.** | [optional] | +| **limit** | **Integer** | For metric queries, the number of lines to show in the table. Only one request should have this property. | [optional] | +| **log_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **network_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **order** | [**WidgetSort**](WidgetSort.md) | | [optional] | +| **process_query** | [**ProcessQueryDefinition**](ProcessQueryDefinition.md) | | [optional] | +| **profile_metrics_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **q** | **String** | Query definition. | [optional] | +| **queries** | [**Array<FormulaAndFunctionQueryDefinition>**](FormulaAndFunctionQueryDefinition.md) | List of queries that can be returned directly or used in formulas. **This feature is currently in beta.** | [optional] | +| **response_format** | [**FormulaAndFunctionResponseFormat**](FormulaAndFunctionResponseFormat.md) | | [optional] | +| **rum_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **security_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | ## Example @@ -51,4 +51,3 @@ instance = DatadogAPIClient::V1::TableWidgetRequest.new( security_query: null ) ``` - diff --git a/docs/v1/TagToHosts.md b/docs/v1/TagToHosts.md index 056e473af818..0fe76015b600 100644 --- a/docs/v1/TagToHosts.md +++ b/docs/v1/TagToHosts.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| -------- | ------------------------------------------- | ------------------------------------ | ---------- | | **tags** | **Hash<String, Array<String>>** | A list of tags to apply to the host. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::TagToHosts.new( tags: null ) ``` - diff --git a/docs/v1/TagsAPI.md b/docs/v1/TagsAPI.md index fdebfbc65b0a..0b87d7d4c73e 100644 --- a/docs/v1/TagsAPI.md +++ b/docs/v1/TagsAPI.md @@ -2,14 +2,13 @@ All URIs are relative to *https://api.datadoghq.com* -| Method | HTTP request | Description | -| ------ | ------------ | ----------- | -| [**create_host_tags**](TagsAPI.md#create_host_tags) | **POST** /api/v1/tags/hosts/{host_name} | Add tags to a host | -| [**delete_host_tags**](TagsAPI.md#delete_host_tags) | **DELETE** /api/v1/tags/hosts/{host_name} | Remove host tags | -| [**get_host_tags**](TagsAPI.md#get_host_tags) | **GET** /api/v1/tags/hosts/{host_name} | Get host tags | -| [**list_host_tags**](TagsAPI.md#list_host_tags) | **GET** /api/v1/tags/hosts | Get Tags | -| [**update_host_tags**](TagsAPI.md#update_host_tags) | **PUT** /api/v1/tags/hosts/{host_name} | Update host tags | - +| Method | HTTP request | Description | +| --------------------------------------------------- | ----------------------------------------- | ------------------ | +| [**create_host_tags**](TagsAPI.md#create_host_tags) | **POST** /api/v1/tags/hosts/{host_name} | Add tags to a host | +| [**delete_host_tags**](TagsAPI.md#delete_host_tags) | **DELETE** /api/v1/tags/hosts/{host_name} | Remove host tags | +| [**get_host_tags**](TagsAPI.md#get_host_tags) | **GET** /api/v1/tags/hosts/{host_name} | Get host tags | +| [**list_host_tags**](TagsAPI.md#list_host_tags) | **GET** /api/v1/tags/hosts | Get Tags | +| [**update_host_tags**](TagsAPI.md#update_host_tags) | **PUT** /api/v1/tags/hosts/{host_name} | Update host tags | ## create_host_tags @@ -58,11 +57,11 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **host_name** | **String** | This endpoint allows you to add new tags to a host, optionally specifying where the tags came from. | | -| **body** | [**HostTags**](HostTags.md) | Update host tags request body. | | -| **source** | **String** | The source of the tags. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value). | [optional] | +| Name | Type | Description | Notes | +| ------------- | --------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **host_name** | **String** | This endpoint allows you to add new tags to a host, optionally specifying where the tags came from. | | +| **body** | [**HostTags**](HostTags.md) | Update host tags request body. | | +| **source** | **String** | The source of the tags. [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value). | [optional] | ### Return type @@ -77,7 +76,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## delete_host_tags > delete_host_tags(host_name, opts) @@ -123,10 +121,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **host_name** | **String** | This endpoint allows you to remove all user-assigned tags for a single host. | | -| **source** | **String** | The source of the tags (e.g. chef, puppet). [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value). | [optional] | +| Name | Type | Description | Notes | +| ------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **host_name** | **String** | This endpoint allows you to remove all user-assigned tags for a single host. | | +| **source** | **String** | The source of the tags (e.g. chef, puppet). [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value). | [optional] | ### Return type @@ -141,7 +139,6 @@ nil (empty response body) - **Content-Type**: Not defined - **Accept**: application/json - ## get_host_tags > get_host_tags(host_name, opts) @@ -187,10 +184,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **host_name** | **String** | When specified, filters list of tags to those tags with the specified source. | | -| **source** | **String** | Source to filter. | [optional] | +| Name | Type | Description | Notes | +| ------------- | ---------- | ----------------------------------------------------------------------------- | ---------- | +| **host_name** | **String** | When specified, filters list of tags to those tags with the specified source. | | +| **source** | **String** | Source to filter. | [optional] | ### Return type @@ -205,7 +202,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## list_host_tags > list_host_tags(opts) @@ -250,8 +246,8 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| ---------- | ---------- | -------------------------------------------------------------------------- | ---------- | | **source** | **String** | When specified, filters host list to those tags with the specified source. | [optional] | ### Return type @@ -267,7 +263,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## update_host_tags > update_host_tags(host_name, body, opts) @@ -315,11 +310,11 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **host_name** | **String** | This endpoint allows you to update/replace all in an integration source with those supplied in the request. | | -| **body** | [**HostTags**](HostTags.md) | Add tags to host | | -| **source** | **String** | The source of the tags (e.g. chef, puppet). [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value) | [optional] | +| Name | Type | Description | Notes | +| ------------- | --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **host_name** | **String** | This endpoint allows you to update/replace all in an integration source with those supplied in the request. | | +| **body** | [**HostTags**](HostTags.md) | Add tags to host | | +| **source** | **String** | The source of the tags (e.g. chef, puppet). [Complete list of source attribute values](https://docs.datadoghq.com/integrations/faq/list-of-api-source-attribute-value) | [optional] | ### Return type @@ -333,4 +328,3 @@ end - **Content-Type**: application/json - **Accept**: application/json - diff --git a/docs/v1/TargetFormatType.md b/docs/v1/TargetFormatType.md index 44f5f3fd7987..e0af22e43c04 100644 --- a/docs/v1/TargetFormatType.md +++ b/docs/v1/TargetFormatType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::TargetFormatType.new() ``` - diff --git a/docs/v1/TimeseriesWidgetDefinition.md b/docs/v1/TimeseriesWidgetDefinition.md index dd0191e781f1..c65eeee75ef0 100644 --- a/docs/v1/TimeseriesWidgetDefinition.md +++ b/docs/v1/TimeseriesWidgetDefinition.md @@ -2,23 +2,23 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **custom_links** | [**Array<WidgetCustomLink>**](WidgetCustomLink.md) | List of custom links. | [optional] | -| **events** | [**Array<WidgetEvent>**](WidgetEvent.md) | List of widget events. | [optional] | -| **legend_columns** | [**Array<TimeseriesWidgetLegendColumn>**](TimeseriesWidgetLegendColumn.md) | Columns displayed in the legend. | [optional] | -| **legend_layout** | [**TimeseriesWidgetLegendLayout**](TimeseriesWidgetLegendLayout.md) | | [optional] | -| **legend_size** | **String** | Available legend sizes for a widget. Should be one of \"0\", \"2\", \"4\", \"8\", \"16\", or \"auto\". | [optional] | -| **markers** | [**Array<WidgetMarker>**](WidgetMarker.md) | List of markers. | [optional] | -| **requests** | [**Array<TimeseriesWidgetRequest>**](TimeseriesWidgetRequest.md) | List of timeseries widget requests. | | -| **right_yaxis** | [**WidgetAxis**](WidgetAxis.md) | | [optional] | -| **show_legend** | **Boolean** | (screenboard only) Show the legend for this widget. | [optional] | -| **time** | [**WidgetTime**](WidgetTime.md) | | [optional] | -| **title** | **String** | Title of your widget. | [optional] | -| **title_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | -| **title_size** | **String** | Size of the title. | [optional] | -| **type** | [**TimeseriesWidgetDefinitionType**](TimeseriesWidgetDefinitionType.md) | | [default to 'timeseries'] | -| **yaxis** | [**WidgetAxis**](WidgetAxis.md) | | [optional] | +| Name | Type | Description | Notes | +| ------------------ | -------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------- | +| **custom_links** | [**Array<WidgetCustomLink>**](WidgetCustomLink.md) | List of custom links. | [optional] | +| **events** | [**Array<WidgetEvent>**](WidgetEvent.md) | List of widget events. | [optional] | +| **legend_columns** | [**Array<TimeseriesWidgetLegendColumn>**](TimeseriesWidgetLegendColumn.md) | Columns displayed in the legend. | [optional] | +| **legend_layout** | [**TimeseriesWidgetLegendLayout**](TimeseriesWidgetLegendLayout.md) | | [optional] | +| **legend_size** | **String** | Available legend sizes for a widget. Should be one of \"0\", \"2\", \"4\", \"8\", \"16\", or \"auto\". | [optional] | +| **markers** | [**Array<WidgetMarker>**](WidgetMarker.md) | List of markers. | [optional] | +| **requests** | [**Array<TimeseriesWidgetRequest>**](TimeseriesWidgetRequest.md) | List of timeseries widget requests. | | +| **right_yaxis** | [**WidgetAxis**](WidgetAxis.md) | | [optional] | +| **show_legend** | **Boolean** | (screenboard only) Show the legend for this widget. | [optional] | +| **time** | [**WidgetTime**](WidgetTime.md) | | [optional] | +| **title** | **String** | Title of your widget. | [optional] | +| **title_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | +| **title_size** | **String** | Size of the title. | [optional] | +| **type** | [**TimeseriesWidgetDefinitionType**](TimeseriesWidgetDefinitionType.md) | | [default to 'timeseries'] | +| **yaxis** | [**WidgetAxis**](WidgetAxis.md) | | [optional] | ## Example @@ -43,4 +43,3 @@ instance = DatadogAPIClient::V1::TimeseriesWidgetDefinition.new( yaxis: null ) ``` - diff --git a/docs/v1/TimeseriesWidgetDefinitionType.md b/docs/v1/TimeseriesWidgetDefinitionType.md index d7d9b5193041..f02ecfa741be 100644 --- a/docs/v1/TimeseriesWidgetDefinitionType.md +++ b/docs/v1/TimeseriesWidgetDefinitionType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::TimeseriesWidgetDefinitionType.new() ``` - diff --git a/docs/v1/TimeseriesWidgetExpressionAlias.md b/docs/v1/TimeseriesWidgetExpressionAlias.md index 34af5f572cc4..b9dcdb5c1ef9 100644 --- a/docs/v1/TimeseriesWidgetExpressionAlias.md +++ b/docs/v1/TimeseriesWidgetExpressionAlias.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| -------------- | ---------- | ----------------- | ---------- | | **alias_name** | **String** | Expression alias. | [optional] | -| **expression** | **String** | Expression name. | | +| **expression** | **String** | Expression name. | | ## Example @@ -14,7 +14,6 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::TimeseriesWidgetExpressionAlias.new( alias_name: null, - expression: + expression: ) ``` - diff --git a/docs/v1/TimeseriesWidgetLegendColumn.md b/docs/v1/TimeseriesWidgetLegendColumn.md index 969bf68ce051..7921cda98e8e 100644 --- a/docs/v1/TimeseriesWidgetLegendColumn.md +++ b/docs/v1/TimeseriesWidgetLegendColumn.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::TimeseriesWidgetLegendColumn.new() ``` - diff --git a/docs/v1/TimeseriesWidgetLegendLayout.md b/docs/v1/TimeseriesWidgetLegendLayout.md index 5a8bb8bff5a4..b35525a709d2 100644 --- a/docs/v1/TimeseriesWidgetLegendLayout.md +++ b/docs/v1/TimeseriesWidgetLegendLayout.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::TimeseriesWidgetLegendLayout.new() ``` - diff --git a/docs/v1/TimeseriesWidgetRequest.md b/docs/v1/TimeseriesWidgetRequest.md index 7959ce76814c..fcc97bc37941 100644 --- a/docs/v1/TimeseriesWidgetRequest.md +++ b/docs/v1/TimeseriesWidgetRequest.md @@ -2,25 +2,25 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **apm_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **audit_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **display_type** | [**WidgetDisplayType**](WidgetDisplayType.md) | | [optional] | -| **event_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **formulas** | [**Array<WidgetFormula>**](WidgetFormula.md) | List of formulas that operate on queries. **This feature is currently in beta.** | [optional] | -| **log_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **metadata** | [**Array<TimeseriesWidgetExpressionAlias>**](TimeseriesWidgetExpressionAlias.md) | Used to define expression aliases. | [optional] | -| **network_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **on_right_yaxis** | **Boolean** | Whether or not to display a second y-axis on the right. | [optional] | -| **process_query** | [**ProcessQueryDefinition**](ProcessQueryDefinition.md) | | [optional] | -| **profile_metrics_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **q** | **String** | Widget query. | [optional] | -| **queries** | [**Array<FormulaAndFunctionQueryDefinition>**](FormulaAndFunctionQueryDefinition.md) | List of queries that can be returned directly or used in formulas. **This feature is currently in beta.** | [optional] | -| **response_format** | [**FormulaAndFunctionResponseFormat**](FormulaAndFunctionResponseFormat.md) | | [optional] | -| **rum_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **security_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **style** | [**WidgetRequestStyle**](WidgetRequestStyle.md) | | [optional] | +| Name | Type | Description | Notes | +| ------------------------- | ------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------- | ---------- | +| **apm_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **audit_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **display_type** | [**WidgetDisplayType**](WidgetDisplayType.md) | | [optional] | +| **event_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **formulas** | [**Array<WidgetFormula>**](WidgetFormula.md) | List of formulas that operate on queries. **This feature is currently in beta.** | [optional] | +| **log_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **metadata** | [**Array<TimeseriesWidgetExpressionAlias>**](TimeseriesWidgetExpressionAlias.md) | Used to define expression aliases. | [optional] | +| **network_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **on_right_yaxis** | **Boolean** | Whether or not to display a second y-axis on the right. | [optional] | +| **process_query** | [**ProcessQueryDefinition**](ProcessQueryDefinition.md) | | [optional] | +| **profile_metrics_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **q** | **String** | Widget query. | [optional] | +| **queries** | [**Array<FormulaAndFunctionQueryDefinition>**](FormulaAndFunctionQueryDefinition.md) | List of queries that can be returned directly or used in formulas. **This feature is currently in beta.** | [optional] | +| **response_format** | [**FormulaAndFunctionResponseFormat**](FormulaAndFunctionResponseFormat.md) | | [optional] | +| **rum_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **security_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **style** | [**WidgetRequestStyle**](WidgetRequestStyle.md) | | [optional] | ## Example @@ -47,4 +47,3 @@ instance = DatadogAPIClient::V1::TimeseriesWidgetRequest.new( style: null ) ``` - diff --git a/docs/v1/ToplistWidgetDefinition.md b/docs/v1/ToplistWidgetDefinition.md index 1eb151051d79..12736fec96af 100644 --- a/docs/v1/ToplistWidgetDefinition.md +++ b/docs/v1/ToplistWidgetDefinition.md @@ -2,15 +2,15 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **custom_links** | [**Array<WidgetCustomLink>**](WidgetCustomLink.md) | List of custom links. | [optional] | -| **requests** | [**Array<ToplistWidgetRequest>**](ToplistWidgetRequest.md) | List of top list widget requests. | | -| **time** | [**WidgetTime**](WidgetTime.md) | | [optional] | -| **title** | **String** | Title of your widget. | [optional] | -| **title_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | -| **title_size** | **String** | Size of the title. | [optional] | -| **type** | [**ToplistWidgetDefinitionType**](ToplistWidgetDefinitionType.md) | | [default to 'toplist'] | +| Name | Type | Description | Notes | +| ---------------- | ----------------------------------------------------------------- | --------------------------------- | ------------------------------ | +| **custom_links** | [**Array<WidgetCustomLink>**](WidgetCustomLink.md) | List of custom links. | [optional] | +| **requests** | [**Array<ToplistWidgetRequest>**](ToplistWidgetRequest.md) | List of top list widget requests. | | +| **time** | [**WidgetTime**](WidgetTime.md) | | [optional] | +| **title** | **String** | Title of your widget. | [optional] | +| **title_align** | [**WidgetTextAlign**](WidgetTextAlign.md) | | [optional] | +| **title_size** | **String** | Size of the title. | [optional] | +| **type** | [**ToplistWidgetDefinitionType**](ToplistWidgetDefinitionType.md) | | [default to 'toplist'] | ## Example @@ -27,4 +27,3 @@ instance = DatadogAPIClient::V1::ToplistWidgetDefinition.new( type: null ) ``` - diff --git a/docs/v1/ToplistWidgetDefinitionType.md b/docs/v1/ToplistWidgetDefinitionType.md index 0360d2cd7c6d..85c04aef588e 100644 --- a/docs/v1/ToplistWidgetDefinitionType.md +++ b/docs/v1/ToplistWidgetDefinitionType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::ToplistWidgetDefinitionType.new() ``` - diff --git a/docs/v1/ToplistWidgetRequest.md b/docs/v1/ToplistWidgetRequest.md index ee1483afcd41..940a57ed93f3 100644 --- a/docs/v1/ToplistWidgetRequest.md +++ b/docs/v1/ToplistWidgetRequest.md @@ -2,23 +2,23 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **apm_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **audit_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **conditional_formats** | [**Array<WidgetConditionalFormat>**](WidgetConditionalFormat.md) | List of conditional formats. | [optional] | -| **event_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **formulas** | [**Array<WidgetFormula>**](WidgetFormula.md) | List of formulas that operate on queries. **This feature is currently in beta.** | [optional] | -| **log_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **network_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **process_query** | [**ProcessQueryDefinition**](ProcessQueryDefinition.md) | | [optional] | -| **profile_metrics_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **q** | **String** | Widget query. | [optional] | -| **queries** | [**Array<FormulaAndFunctionQueryDefinition>**](FormulaAndFunctionQueryDefinition.md) | List of queries that can be returned directly or used in formulas. **This feature is currently in beta.** | [optional] | -| **response_format** | [**FormulaAndFunctionResponseFormat**](FormulaAndFunctionResponseFormat.md) | | [optional] | -| **rum_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **security_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | -| **style** | [**WidgetRequestStyle**](WidgetRequestStyle.md) | | [optional] | +| Name | Type | Description | Notes | +| ------------------------- | ------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------- | ---------- | +| **apm_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **audit_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **conditional_formats** | [**Array<WidgetConditionalFormat>**](WidgetConditionalFormat.md) | List of conditional formats. | [optional] | +| **event_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **formulas** | [**Array<WidgetFormula>**](WidgetFormula.md) | List of formulas that operate on queries. **This feature is currently in beta.** | [optional] | +| **log_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **network_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **process_query** | [**ProcessQueryDefinition**](ProcessQueryDefinition.md) | | [optional] | +| **profile_metrics_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **q** | **String** | Widget query. | [optional] | +| **queries** | [**Array<FormulaAndFunctionQueryDefinition>**](FormulaAndFunctionQueryDefinition.md) | List of queries that can be returned directly or used in formulas. **This feature is currently in beta.** | [optional] | +| **response_format** | [**FormulaAndFunctionResponseFormat**](FormulaAndFunctionResponseFormat.md) | | [optional] | +| **rum_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **security_query** | [**LogQueryDefinition**](LogQueryDefinition.md) | | [optional] | +| **style** | [**WidgetRequestStyle**](WidgetRequestStyle.md) | | [optional] | ## Example @@ -43,4 +43,3 @@ instance = DatadogAPIClient::V1::ToplistWidgetRequest.new( style: null ) ``` - diff --git a/docs/v1/TreeMapColorBy.md b/docs/v1/TreeMapColorBy.md index 61d5f2485f21..c0f4d84ec31b 100644 --- a/docs/v1/TreeMapColorBy.md +++ b/docs/v1/TreeMapColorBy.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::TreeMapColorBy.new() ``` - diff --git a/docs/v1/TreeMapGroupBy.md b/docs/v1/TreeMapGroupBy.md index d8d3cfc7f46d..6d1683c54365 100644 --- a/docs/v1/TreeMapGroupBy.md +++ b/docs/v1/TreeMapGroupBy.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::TreeMapGroupBy.new() ``` - diff --git a/docs/v1/TreeMapSizeBy.md b/docs/v1/TreeMapSizeBy.md index 3b06b3185ff2..a94d01d1edd3 100644 --- a/docs/v1/TreeMapSizeBy.md +++ b/docs/v1/TreeMapSizeBy.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::TreeMapSizeBy.new() ``` - diff --git a/docs/v1/TreeMapWidgetDefinition.md b/docs/v1/TreeMapWidgetDefinition.md index 8f124348f5bb..8b9ce3f21d88 100644 --- a/docs/v1/TreeMapWidgetDefinition.md +++ b/docs/v1/TreeMapWidgetDefinition.md @@ -2,14 +2,14 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **color_by** | [**TreeMapColorBy**](TreeMapColorBy.md) | | [default to 'user'] | -| **group_by** | [**TreeMapGroupBy**](TreeMapGroupBy.md) | | | -| **requests** | [**Array<TreeMapWidgetRequest>**](TreeMapWidgetRequest.md) | List of top list widget requests. | | -| **size_by** | [**TreeMapSizeBy**](TreeMapSizeBy.md) | | | -| **title** | **String** | Title of your widget. | [optional] | -| **type** | [**TreeMapWidgetDefinitionType**](TreeMapWidgetDefinitionType.md) | | [default to 'treemap'] | +| Name | Type | Description | Notes | +| ------------ | ----------------------------------------------------------------- | --------------------------------- | ------------------------------ | +| **color_by** | [**TreeMapColorBy**](TreeMapColorBy.md) | | [default to 'user'] | +| **group_by** | [**TreeMapGroupBy**](TreeMapGroupBy.md) | | | +| **requests** | [**Array<TreeMapWidgetRequest>**](TreeMapWidgetRequest.md) | List of top list widget requests. | | +| **size_by** | [**TreeMapSizeBy**](TreeMapSizeBy.md) | | | +| **title** | **String** | Title of your widget. | [optional] | +| **type** | [**TreeMapWidgetDefinitionType**](TreeMapWidgetDefinitionType.md) | | [default to 'treemap'] | ## Example @@ -25,4 +25,3 @@ instance = DatadogAPIClient::V1::TreeMapWidgetDefinition.new( type: null ) ``` - diff --git a/docs/v1/TreeMapWidgetDefinitionType.md b/docs/v1/TreeMapWidgetDefinitionType.md index 97a5a2e1427d..a661e6b33f0b 100644 --- a/docs/v1/TreeMapWidgetDefinitionType.md +++ b/docs/v1/TreeMapWidgetDefinitionType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::TreeMapWidgetDefinitionType.new() ``` - diff --git a/docs/v1/TreeMapWidgetRequest.md b/docs/v1/TreeMapWidgetRequest.md index ae8753c1b5b8..5497e5aa93fa 100644 --- a/docs/v1/TreeMapWidgetRequest.md +++ b/docs/v1/TreeMapWidgetRequest.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| ----- | ---------- | ------------------------- | ---------- | | **q** | **String** | The widget metrics query. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::TreeMapWidgetRequest.new( q: null ) ``` - diff --git a/docs/v1/UsageAnalyzedLogsHour.md b/docs/v1/UsageAnalyzedLogsHour.md index aeedd6026d17..54c98dc1febc 100644 --- a/docs/v1/UsageAnalyzedLogsHour.md +++ b/docs/v1/UsageAnalyzedLogsHour.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| ----------------- | ----------- | ------------------------------------- | ---------- | | **analyzed_logs** | **Integer** | Contains the number of analyzed logs. | [optional] | -| **hour** | **Time** | The hour for the usage. | [optional] | +| **hour** | **Time** | The hour for the usage. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::UsageAnalyzedLogsHour.new( hour: null ) ``` - diff --git a/docs/v1/UsageAnalyzedLogsResponse.md b/docs/v1/UsageAnalyzedLogsResponse.md index 90818c53bc9e..d20f5b8e377f 100644 --- a/docs/v1/UsageAnalyzedLogsResponse.md +++ b/docs/v1/UsageAnalyzedLogsResponse.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| --------- | ------------------------------------------------------------------ | ----------------------------------- | ---------- | | **usage** | [**Array<UsageAnalyzedLogsHour>**](UsageAnalyzedLogsHour.md) | Get hourly usage for analyzed logs. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::UsageAnalyzedLogsResponse.new( usage: null ) ``` - diff --git a/docs/v1/UsageAttributionAggregatesBody.md b/docs/v1/UsageAttributionAggregatesBody.md index 021d03c9f65b..6dadaaf61248 100644 --- a/docs/v1/UsageAttributionAggregatesBody.md +++ b/docs/v1/UsageAttributionAggregatesBody.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **agg_type** | **String** | The aggregate type. | [optional] | -| **field** | **String** | The field. | [optional] | -| **value** | **Float** | The value for a given field. | [optional] | +| Name | Type | Description | Notes | +| ------------ | ---------- | ---------------------------- | ---------- | +| **agg_type** | **String** | The aggregate type. | [optional] | +| **field** | **String** | The field. | [optional] | +| **value** | **Float** | The value for a given field. | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::UsageAttributionAggregatesBody.new( value: null ) ``` - diff --git a/docs/v1/UsageAttributionBody.md b/docs/v1/UsageAttributionBody.md index 5f6b7bba5313..f30458dd4a6f 100644 --- a/docs/v1/UsageAttributionBody.md +++ b/docs/v1/UsageAttributionBody.md @@ -2,15 +2,15 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **month** | **Time** | Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM]. | [optional] | -| **org_name** | **String** | The name of the organization. | [optional] | -| **public_id** | **String** | The organization public ID. | [optional] | -| **tag_config_source** | **String** | The source of the usage attribution tag configuration and the selected tags in the format `<source_org_name>:<selected tag 1>-<selected tag 2>-<selected tag 3>`. | [optional] | -| **tags** | **Hash<String, Array<String>>** | Usage Summary by tag name. | [optional] | -| **updated_at** | **String** | Shows the the most recent hour in the current months for all organizations for which all usages were calculated. | [optional] | -| **values** | [**UsageAttributionValues**](UsageAttributionValues.md) | | [optional] | +| Name | Type | Description | Notes | +| --------------------- | ------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **month** | **Time** | Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM]. | [optional] | +| **org_name** | **String** | The name of the organization. | [optional] | +| **public_id** | **String** | The organization public ID. | [optional] | +| **tag_config_source** | **String** | The source of the usage attribution tag configuration and the selected tags in the format `<source_org_name>:<selected tag 1>-<selected tag 2>-<selected tag 3>`. | [optional] | +| **tags** | **Hash<String, Array<String>>** | Usage Summary by tag name. | [optional] | +| **updated_at** | **String** | Shows the the most recent hour in the current months for all organizations for which all usages were calculated. | [optional] | +| **values** | [**UsageAttributionValues**](UsageAttributionValues.md) | | [optional] | ## Example @@ -27,4 +27,3 @@ instance = DatadogAPIClient::V1::UsageAttributionBody.new( values: null ) ``` - diff --git a/docs/v1/UsageAttributionMetadata.md b/docs/v1/UsageAttributionMetadata.md index 0b51d7c2b5ed..ee8f9231a497 100644 --- a/docs/v1/UsageAttributionMetadata.md +++ b/docs/v1/UsageAttributionMetadata.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| -------------- | ------------------------------------------------------------------------------------ | --------------------------------- | ---------- | | **aggregates** | [**Array<UsageAttributionAggregatesBody>**](UsageAttributionAggregatesBody.md) | An array of available aggregates. | [optional] | -| **pagination** | [**UsageAttributionPagination**](UsageAttributionPagination.md) | | [optional] | +| **pagination** | [**UsageAttributionPagination**](UsageAttributionPagination.md) | | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::UsageAttributionMetadata.new( pagination: null ) ``` - diff --git a/docs/v1/UsageAttributionPagination.md b/docs/v1/UsageAttributionPagination.md index 8aa851b83956..9be8c3416e10 100644 --- a/docs/v1/UsageAttributionPagination.md +++ b/docs/v1/UsageAttributionPagination.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **limit** | **Integer** | Maximum amount of records to be returned. | [optional] | -| **next_record_id** | **String** | The cursor to use to get the next results, if any. To make the next request, use the same parameters with the addition of this next_record_id. | [optional] | -| **total_number_of_records** | **Integer** | Total number of records. (deprecated after May 1st, 2021) | [optional] | +| Name | Type | Description | Notes | +| --------------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **limit** | **Integer** | Maximum amount of records to be returned. | [optional] | +| **next_record_id** | **String** | The cursor to use to get the next results, if any. To make the next request, use the same parameters with the addition of this next_record_id. | [optional] | +| **total_number_of_records** | **Integer** | Total number of records. (deprecated after May 1st, 2021) | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::UsageAttributionPagination.new( total_number_of_records: null ) ``` - diff --git a/docs/v1/UsageAttributionResponse.md b/docs/v1/UsageAttributionResponse.md index 6415424a0214..e2561b9a06d8 100644 --- a/docs/v1/UsageAttributionResponse.md +++ b/docs/v1/UsageAttributionResponse.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **metadata** | [**UsageAttributionMetadata**](UsageAttributionMetadata.md) | | [optional] | -| **usage** | [**Array<UsageAttributionBody>**](UsageAttributionBody.md) | Get Usage Summary by tag(s). | [optional] | +| Name | Type | Description | Notes | +| ------------ | ---------------------------------------------------------------- | ---------------------------- | ---------- | +| **metadata** | [**UsageAttributionMetadata**](UsageAttributionMetadata.md) | | [optional] | +| **usage** | [**Array<UsageAttributionBody>**](UsageAttributionBody.md) | Get Usage Summary by tag(s). | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::UsageAttributionResponse.new( usage: null ) ``` - diff --git a/docs/v1/UsageAttributionSort.md b/docs/v1/UsageAttributionSort.md index 73ab4fb725f0..2486a48c4f6c 100644 --- a/docs/v1/UsageAttributionSort.md +++ b/docs/v1/UsageAttributionSort.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::UsageAttributionSort.new() ``` - diff --git a/docs/v1/UsageAttributionSupportedMetrics.md b/docs/v1/UsageAttributionSupportedMetrics.md index 68a03170d703..cbdf3be0dffb 100644 --- a/docs/v1/UsageAttributionSupportedMetrics.md +++ b/docs/v1/UsageAttributionSupportedMetrics.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::UsageAttributionSupportedMetrics.new() ``` - diff --git a/docs/v1/UsageAttributionValues.md b/docs/v1/UsageAttributionValues.md index 49a7dd22a85e..1e29865b57c4 100644 --- a/docs/v1/UsageAttributionValues.md +++ b/docs/v1/UsageAttributionValues.md @@ -2,46 +2,46 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **api_percentage** | **Float** | The percentage of synthetic API test usage by tag(s). | [optional] | -| **api_usage** | **Float** | The synthetic API test usage by tag(s). | [optional] | -| **apm_host_percentage** | **Float** | The percentage of APM host usage by tag(s). | [optional] | -| **apm_host_usage** | **Float** | The APM host usage by tag(s). | [optional] | -| **browser_percentage** | **Float** | The percentage of synthetic browser test usage by tag(s). | [optional] | -| **browser_usage** | **Float** | The synthetic browser test usage by tag(s). | [optional] | -| **container_percentage** | **Float** | The percentage of container usage by tag(s). | [optional] | -| **container_usage** | **Float** | The container usage by tag(s). | [optional] | -| **cspm_container_percentage** | **Float** | The percentage of Cloud Security Posture Management container usage by tag(s) | [optional] | -| **cspm_container_usage** | **Float** | The Cloud Security Posture Management container usage by tag(s) | [optional] | -| **cspm_host_percentage** | **Float** | The percentage of Cloud Security Posture Management host usage by tag(s) | [optional] | -| **cspm_host_usage** | **Float** | The Cloud Security Posture Management host usage by tag(s) | [optional] | -| **custom_timeseries_percentage** | **Float** | The percentage of custom metrics usage by tag(s). | [optional] | -| **custom_timeseries_usage** | **Float** | The custom metrics usage by tag(s). | [optional] | -| **cws_container_percentage** | **Float** | The percentage of Cloud Workload Security container usage by tag(s) | [optional] | -| **cws_container_usage** | **Float** | The Cloud Workload Security container usage by tag(s) | [optional] | -| **cws_host_percentage** | **Float** | The percentage of Cloud Workload Security host usage by tag(s) | [optional] | -| **cws_host_usage** | **Float** | The Cloud Workload Security host usage by tag(s) | [optional] | -| **dbm_hosts_percentage** | **Float** | The percentage of Database Monitoring host usage by tag(s). | [optional] | -| **dbm_hosts_usage** | **Float** | The Database Monitoring host usage by tag(s). | [optional] | -| **dbm_queries_percentage** | **Float** | The percentage of Database Monitoring normalized queries usage by tag(s). | [optional] | -| **dbm_queries_usage** | **Float** | The Database Monitoring normalized queries usage by tag(s). | [optional] | -| **infra_host_percentage** | **Float** | The percentage of infrastructure host usage by tag(s). | [optional] | -| **infra_host_usage** | **Float** | The infrastructure host usage by tag(s). | [optional] | -| **lambda_functions_percentage** | **Float** | The percentage of Lambda function usage by tag(s). | [optional] | -| **lambda_functions_usage** | **Float** | The Lambda function usage by tag(s). | [optional] | -| **lambda_invocations_percentage** | **Float** | The percentage of Lambda invocation usage by tag(s). | [optional] | -| **lambda_invocations_usage** | **Float** | The Lambda invocation usage by tag(s). | [optional] | -| **lambda_percentage** | **Float** | The percentage of Lambda function usage by tag(s). **Note** this field is deprecated. Use lambda_functions_percentage instead. | [optional] | -| **lambda_usage** | **Float** | The Lambda function usage by tag(s). **Note** this field is deprecated. Use lambda_functions_usage instead. | [optional] | -| **npm_host_percentage** | **Float** | The percentage of network host usage by tag(s). | [optional] | -| **npm_host_usage** | **Float** | The network host usage by tag(s). | [optional] | -| **profiled_container_percentage** | **Float** | The percentage of profiled containers usage by tag(s). | [optional] | -| **profiled_container_usage** | **Float** | The profiled container usage by tag(s). | [optional] | -| **profiled_hosts_percentage** | **Float** | The percentage of profiled hosts usage by tag(s). | [optional] | -| **profiled_hosts_usage** | **Float** | The profiled host usage by tag(s). | [optional] | -| **snmp_percentage** | **Float** | The percentage of network device usage by tag(s). | [optional] | -| **snmp_usage** | **Float** | The network device usage by tag(s). | [optional] | +| Name | Type | Description | Notes | +| --------------------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------ | ---------- | +| **api_percentage** | **Float** | The percentage of synthetic API test usage by tag(s). | [optional] | +| **api_usage** | **Float** | The synthetic API test usage by tag(s). | [optional] | +| **apm_host_percentage** | **Float** | The percentage of APM host usage by tag(s). | [optional] | +| **apm_host_usage** | **Float** | The APM host usage by tag(s). | [optional] | +| **browser_percentage** | **Float** | The percentage of synthetic browser test usage by tag(s). | [optional] | +| **browser_usage** | **Float** | The synthetic browser test usage by tag(s). | [optional] | +| **container_percentage** | **Float** | The percentage of container usage by tag(s). | [optional] | +| **container_usage** | **Float** | The container usage by tag(s). | [optional] | +| **cspm_container_percentage** | **Float** | The percentage of Cloud Security Posture Management container usage by tag(s) | [optional] | +| **cspm_container_usage** | **Float** | The Cloud Security Posture Management container usage by tag(s) | [optional] | +| **cspm_host_percentage** | **Float** | The percentage of Cloud Security Posture Management host usage by tag(s) | [optional] | +| **cspm_host_usage** | **Float** | The Cloud Security Posture Management host usage by tag(s) | [optional] | +| **custom_timeseries_percentage** | **Float** | The percentage of custom metrics usage by tag(s). | [optional] | +| **custom_timeseries_usage** | **Float** | The custom metrics usage by tag(s). | [optional] | +| **cws_container_percentage** | **Float** | The percentage of Cloud Workload Security container usage by tag(s) | [optional] | +| **cws_container_usage** | **Float** | The Cloud Workload Security container usage by tag(s) | [optional] | +| **cws_host_percentage** | **Float** | The percentage of Cloud Workload Security host usage by tag(s) | [optional] | +| **cws_host_usage** | **Float** | The Cloud Workload Security host usage by tag(s) | [optional] | +| **dbm_hosts_percentage** | **Float** | The percentage of Database Monitoring host usage by tag(s). | [optional] | +| **dbm_hosts_usage** | **Float** | The Database Monitoring host usage by tag(s). | [optional] | +| **dbm_queries_percentage** | **Float** | The percentage of Database Monitoring normalized queries usage by tag(s). | [optional] | +| **dbm_queries_usage** | **Float** | The Database Monitoring normalized queries usage by tag(s). | [optional] | +| **infra_host_percentage** | **Float** | The percentage of infrastructure host usage by tag(s). | [optional] | +| **infra_host_usage** | **Float** | The infrastructure host usage by tag(s). | [optional] | +| **lambda_functions_percentage** | **Float** | The percentage of Lambda function usage by tag(s). | [optional] | +| **lambda_functions_usage** | **Float** | The Lambda function usage by tag(s). | [optional] | +| **lambda_invocations_percentage** | **Float** | The percentage of Lambda invocation usage by tag(s). | [optional] | +| **lambda_invocations_usage** | **Float** | The Lambda invocation usage by tag(s). | [optional] | +| **lambda_percentage** | **Float** | The percentage of Lambda function usage by tag(s). **Note** this field is deprecated. Use lambda_functions_percentage instead. | [optional] | +| **lambda_usage** | **Float** | The Lambda function usage by tag(s). **Note** this field is deprecated. Use lambda_functions_usage instead. | [optional] | +| **npm_host_percentage** | **Float** | The percentage of network host usage by tag(s). | [optional] | +| **npm_host_usage** | **Float** | The network host usage by tag(s). | [optional] | +| **profiled_container_percentage** | **Float** | The percentage of profiled containers usage by tag(s). | [optional] | +| **profiled_container_usage** | **Float** | The profiled container usage by tag(s). | [optional] | +| **profiled_hosts_percentage** | **Float** | The percentage of profiled hosts usage by tag(s). | [optional] | +| **profiled_hosts_usage** | **Float** | The profiled host usage by tag(s). | [optional] | +| **snmp_percentage** | **Float** | The percentage of network device usage by tag(s). | [optional] | +| **snmp_usage** | **Float** | The network device usage by tag(s). | [optional] | ## Example @@ -89,4 +89,3 @@ instance = DatadogAPIClient::V1::UsageAttributionValues.new( snmp_usage: null ) ``` - diff --git a/docs/v1/UsageAuditLogsHour.md b/docs/v1/UsageAuditLogsHour.md index be83a1db2c02..fbaa9f0d6d65 100644 --- a/docs/v1/UsageAuditLogsHour.md +++ b/docs/v1/UsageAuditLogsHour.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **hour** | **Time** | The hour for the usage. | [optional] | +| Name | Type | Description | Notes | +| ----------------- | ----------- | ----------------------------------------------------------------- | ---------- | +| **hour** | **Time** | The hour for the usage. | [optional] | | **lines_indexed** | **Integer** | The total number of audit logs lines indexed during a given hour. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::UsageAuditLogsHour.new( lines_indexed: null ) ``` - diff --git a/docs/v1/UsageAuditLogsResponse.md b/docs/v1/UsageAuditLogsResponse.md index 20595797dc47..36c03d0ff66d 100644 --- a/docs/v1/UsageAuditLogsResponse.md +++ b/docs/v1/UsageAuditLogsResponse.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| --------- | ------------------------------------------------------------ | -------------------------------- | ---------- | | **usage** | [**Array<UsageAuditLogsHour>**](UsageAuditLogsHour.md) | Get hourly usage for audit logs. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::UsageAuditLogsResponse.new( usage: null ) ``` - diff --git a/docs/v1/UsageBillableSummaryBody.md b/docs/v1/UsageBillableSummaryBody.md index 9c7893889ed0..04fc6cc2d5fb 100644 --- a/docs/v1/UsageBillableSummaryBody.md +++ b/docs/v1/UsageBillableSummaryBody.md @@ -2,15 +2,15 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **account_billable_usage** | **Integer** | The total account usage. | [optional] | -| **elapsed_usage_hours** | **Integer** | Elapsed usage hours for some billable product. | [optional] | -| **first_billable_usage_hour** | **Time** | The first billable hour for the org. | [optional] | -| **last_billable_usage_hour** | **Time** | The last billable hour for the org. | [optional] | -| **org_billable_usage** | **Integer** | The number of units used within the billable timeframe. | [optional] | -| **percentage_in_account** | **Float** | The percentage of account usage the org represents. | [optional] | -| **usage_unit** | **String** | Units pertaining to the usage. | [optional] | +| Name | Type | Description | Notes | +| ----------------------------- | ----------- | ------------------------------------------------------- | ---------- | +| **account_billable_usage** | **Integer** | The total account usage. | [optional] | +| **elapsed_usage_hours** | **Integer** | Elapsed usage hours for some billable product. | [optional] | +| **first_billable_usage_hour** | **Time** | The first billable hour for the org. | [optional] | +| **last_billable_usage_hour** | **Time** | The last billable hour for the org. | [optional] | +| **org_billable_usage** | **Integer** | The number of units used within the billable timeframe. | [optional] | +| **percentage_in_account** | **Float** | The percentage of account usage the org represents. | [optional] | +| **usage_unit** | **String** | Units pertaining to the usage. | [optional] | ## Example @@ -27,4 +27,3 @@ instance = DatadogAPIClient::V1::UsageBillableSummaryBody.new( usage_unit: null ) ``` - diff --git a/docs/v1/UsageBillableSummaryHour.md b/docs/v1/UsageBillableSummaryHour.md index 4b018dda52f4..eff0e12c327e 100644 --- a/docs/v1/UsageBillableSummaryHour.md +++ b/docs/v1/UsageBillableSummaryHour.md @@ -2,16 +2,16 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **billing_plan** | **String** | The billing plan. | [optional] | -| **end_date** | **Time** | Shows the last date of usage. | [optional] | -| **num_orgs** | **Integer** | The number of organizations. | [optional] | -| **org_name** | **String** | The organization name. | [optional] | -| **public_id** | **String** | The organization public ID. | [optional] | -| **ratio_in_month** | **Integer** | Shows usage aggregation for a billing period. | [optional] | -| **start_date** | **Time** | Shows the first date of usage. | [optional] | -| **usage** | [**UsageBillableSummaryKeys**](UsageBillableSummaryKeys.md) | | [optional] | +| Name | Type | Description | Notes | +| ------------------ | ----------------------------------------------------------- | --------------------------------------------- | ---------- | +| **billing_plan** | **String** | The billing plan. | [optional] | +| **end_date** | **Time** | Shows the last date of usage. | [optional] | +| **num_orgs** | **Integer** | The number of organizations. | [optional] | +| **org_name** | **String** | The organization name. | [optional] | +| **public_id** | **String** | The organization public ID. | [optional] | +| **ratio_in_month** | **Integer** | Shows usage aggregation for a billing period. | [optional] | +| **start_date** | **Time** | Shows the first date of usage. | [optional] | +| **usage** | [**UsageBillableSummaryKeys**](UsageBillableSummaryKeys.md) | | [optional] | ## Example @@ -29,4 +29,3 @@ instance = DatadogAPIClient::V1::UsageBillableSummaryHour.new( usage: null ) ``` - diff --git a/docs/v1/UsageBillableSummaryKeys.md b/docs/v1/UsageBillableSummaryKeys.md index 35d289f398e8..b6cc3f61e877 100644 --- a/docs/v1/UsageBillableSummaryKeys.md +++ b/docs/v1/UsageBillableSummaryKeys.md @@ -2,40 +2,40 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **apm_host_sum** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | -| **apm_host_top99p** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | -| **apm_trace_search_sum** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | -| **fargate_container_average** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | -| **infra_container_sum** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | -| **infra_host_sum** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | -| **infra_host_top99p** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | -| **iot_top99p** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | -| **lambda_function_average** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | -| **logs_indexed_15day_sum** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | -| **logs_indexed_180day_sum** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | -| **logs_indexed_30day_sum** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | -| **logs_indexed_3day_sum** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | -| **logs_indexed_45day_sum** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | -| **logs_indexed_60day_sum** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | -| **logs_indexed_7day_sum** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | -| **logs_indexed_90day_sum** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | -| **logs_indexed_custom_retention_sum** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | -| **logs_indexed_sum** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | -| **logs_ingested_sum** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | -| **network_device_top99p** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | -| **npm_flow_sum** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | -| **npm_host_sum** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | -| **npm_host_top99p** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | -| **prof_container_sum** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | -| **prof_host_top99p** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | -| **rum_sum** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | -| **serverless_invocation_sum** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | -| **siem_sum** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | -| **synthetics_api_tests_sum** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | -| **synthetics_browser_checks_sum** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | -| **timeseries_average** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | +| Name | Type | Description | Notes | +| ------------------------------------- | ----------------------------------------------------------- | ----------- | ---------- | +| **apm_host_sum** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | +| **apm_host_top99p** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | +| **apm_trace_search_sum** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | +| **fargate_container_average** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | +| **infra_container_sum** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | +| **infra_host_sum** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | +| **infra_host_top99p** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | +| **iot_top99p** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | +| **lambda_function_average** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | +| **logs_indexed_15day_sum** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | +| **logs_indexed_180day_sum** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | +| **logs_indexed_30day_sum** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | +| **logs_indexed_3day_sum** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | +| **logs_indexed_45day_sum** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | +| **logs_indexed_60day_sum** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | +| **logs_indexed_7day_sum** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | +| **logs_indexed_90day_sum** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | +| **logs_indexed_custom_retention_sum** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | +| **logs_indexed_sum** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | +| **logs_ingested_sum** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | +| **network_device_top99p** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | +| **npm_flow_sum** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | +| **npm_host_sum** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | +| **npm_host_top99p** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | +| **prof_container_sum** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | +| **prof_host_top99p** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | +| **rum_sum** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | +| **serverless_invocation_sum** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | +| **siem_sum** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | +| **synthetics_api_tests_sum** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | +| **synthetics_browser_checks_sum** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | +| **timeseries_average** | [**UsageBillableSummaryBody**](UsageBillableSummaryBody.md) | | [optional] | ## Example @@ -77,4 +77,3 @@ instance = DatadogAPIClient::V1::UsageBillableSummaryKeys.new( timeseries_average: null ) ``` - diff --git a/docs/v1/UsageBillableSummaryResponse.md b/docs/v1/UsageBillableSummaryResponse.md index e8113805bb66..520fb5257d41 100644 --- a/docs/v1/UsageBillableSummaryResponse.md +++ b/docs/v1/UsageBillableSummaryResponse.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| --------- | ------------------------------------------------------------------------ | -------------------------------------------------------- | ---------- | | **usage** | [**Array<UsageBillableSummaryHour>**](UsageBillableSummaryHour.md) | An array of objects regarding usage of billable summary. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::UsageBillableSummaryResponse.new( usage: null ) ``` - diff --git a/docs/v1/UsageCWSHour.md b/docs/v1/UsageCWSHour.md index fab9f493b34e..e801d5e7dacf 100644 --- a/docs/v1/UsageCWSHour.md +++ b/docs/v1/UsageCWSHour.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| ----------------------- | ----------- | -------------------------------------------------------------------------------------------------------------------------- | ---------- | | **cws_container_count** | **Integer** | The total number of Cloud Workload Security container hours from the start of the given hour’s month until the given hour. | [optional] | -| **cws_host_count** | **Integer** | The total number of Cloud Workload Security host hours from the start of the given hour’s month until the given hour. | [optional] | -| **hour** | **Time** | The hour for the usage. | [optional] | +| **cws_host_count** | **Integer** | The total number of Cloud Workload Security host hours from the start of the given hour’s month until the given hour. | [optional] | +| **hour** | **Time** | The hour for the usage. | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::UsageCWSHour.new( hour: null ) ``` - diff --git a/docs/v1/UsageCWSResponse.md b/docs/v1/UsageCWSResponse.md index dd40490d99f6..d23e7a748f7f 100644 --- a/docs/v1/UsageCWSResponse.md +++ b/docs/v1/UsageCWSResponse.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| --------- | ------------------------------------------------ | --------------------------------------------- | ---------- | | **usage** | [**Array<UsageCWSHour>**](UsageCWSHour.md) | Get hourly usage for Cloud Workload Security. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::UsageCWSResponse.new( usage: null ) ``` - diff --git a/docs/v1/UsageCloudSecurityPostureManagementHour.md b/docs/v1/UsageCloudSecurityPostureManagementHour.md index 74023199ad7d..4dc7fb44344d 100644 --- a/docs/v1/UsageCloudSecurityPostureManagementHour.md +++ b/docs/v1/UsageCloudSecurityPostureManagementHour.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| ------------------- | ----------- | ------------------------------------------------------------------------------------- | ---------- | | **container_count** | **Integer** | The total number of Cloud Security Posture Management containers during a given hour. | [optional] | -| **host_count** | **Integer** | The total number of Cloud Security Posture Management hosts during a given hour. | [optional] | -| **hour** | **Time** | The hour for the usage. | [optional] | +| **host_count** | **Integer** | The total number of Cloud Security Posture Management hosts during a given hour. | [optional] | +| **hour** | **Time** | The hour for the usage. | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::UsageCloudSecurityPostureManagementHour.new( hour: null ) ``` - diff --git a/docs/v1/UsageCloudSecurityPostureManagementResponse.md b/docs/v1/UsageCloudSecurityPostureManagementResponse.md index eb1b0dd12e2f..c207d685c889 100644 --- a/docs/v1/UsageCloudSecurityPostureManagementResponse.md +++ b/docs/v1/UsageCloudSecurityPostureManagementResponse.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| --------- | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------- | ---------- | | **usage** | [**Array<UsageCloudSecurityPostureManagementHour>**](UsageCloudSecurityPostureManagementHour.md) | Get hourly usage for Cloud Security Posture Management. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::UsageCloudSecurityPostureManagementResponse.new usage: null ) ``` - diff --git a/docs/v1/UsageCustomReportsAttributes.md b/docs/v1/UsageCustomReportsAttributes.md index 0b848a2f8e8c..658cfffda4e4 100644 --- a/docs/v1/UsageCustomReportsAttributes.md +++ b/docs/v1/UsageCustomReportsAttributes.md @@ -2,13 +2,13 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **computed_on** | **String** | The date the specified custom report was computed. | [optional] | -| **end_date** | **String** | The ending date of custom report. | [optional] | -| **size** | **Integer** | size | [optional] | -| **start_date** | **String** | The starting date of custom report. | [optional] | -| **tags** | **Array<String>** | A list of tags to apply to custom reports. | [optional] | +| Name | Type | Description | Notes | +| --------------- | ----------------------- | -------------------------------------------------- | ---------- | +| **computed_on** | **String** | The date the specified custom report was computed. | [optional] | +| **end_date** | **String** | The ending date of custom report. | [optional] | +| **size** | **Integer** | size | [optional] | +| **start_date** | **String** | The starting date of custom report. | [optional] | +| **tags** | **Array<String>** | A list of tags to apply to custom reports. | [optional] | ## Example @@ -23,4 +23,3 @@ instance = DatadogAPIClient::V1::UsageCustomReportsAttributes.new( tags: null ) ``` - diff --git a/docs/v1/UsageCustomReportsData.md b/docs/v1/UsageCustomReportsData.md index aeb0e6ea16b2..6cbea87edc0a 100644 --- a/docs/v1/UsageCustomReportsData.md +++ b/docs/v1/UsageCustomReportsData.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**UsageCustomReportsAttributes**](UsageCustomReportsAttributes.md) | | [optional] | -| **id** | **String** | The date for specified custom reports. | [optional] | -| **type** | [**UsageReportsType**](UsageReportsType.md) | | [optional][default to 'reports'] | +| Name | Type | Description | Notes | +| -------------- | ------------------------------------------------------------------- | -------------------------------------- | ---------------------------------------- | +| **attributes** | [**UsageCustomReportsAttributes**](UsageCustomReportsAttributes.md) | | [optional] | +| **id** | **String** | The date for specified custom reports. | [optional] | +| **type** | [**UsageReportsType**](UsageReportsType.md) | | [optional][default to 'reports'] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::UsageCustomReportsData.new( type: null ) ``` - diff --git a/docs/v1/UsageCustomReportsMeta.md b/docs/v1/UsageCustomReportsMeta.md index b2bd521ae155..502e144b348c 100644 --- a/docs/v1/UsageCustomReportsMeta.md +++ b/docs/v1/UsageCustomReportsMeta.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **page** | [**UsageCustomReportsPage**](UsageCustomReportsPage.md) | | [optional] | +| Name | Type | Description | Notes | +| -------- | ------------------------------------------------------- | ----------- | ---------- | +| **page** | [**UsageCustomReportsPage**](UsageCustomReportsPage.md) | | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::UsageCustomReportsMeta.new( page: null ) ``` - diff --git a/docs/v1/UsageCustomReportsPage.md b/docs/v1/UsageCustomReportsPage.md index 9037a2faaef2..5fa77a6382d9 100644 --- a/docs/v1/UsageCustomReportsPage.md +++ b/docs/v1/UsageCustomReportsPage.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| --------------- | ----------- | ----------------- | ---------- | | **total_count** | **Integer** | Total page count. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::UsageCustomReportsPage.new( total_count: null ) ``` - diff --git a/docs/v1/UsageCustomReportsResponse.md b/docs/v1/UsageCustomReportsResponse.md index cb7758d84b2a..5216660874f2 100644 --- a/docs/v1/UsageCustomReportsResponse.md +++ b/docs/v1/UsageCustomReportsResponse.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| -------- | -------------------------------------------------------------------- | ------------------------------------- | ---------- | | **data** | [**Array<UsageCustomReportsData>**](UsageCustomReportsData.md) | An array of available custom reports. | [optional] | -| **meta** | [**UsageCustomReportsMeta**](UsageCustomReportsMeta.md) | | [optional] | +| **meta** | [**UsageCustomReportsMeta**](UsageCustomReportsMeta.md) | | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::UsageCustomReportsResponse.new( meta: null ) ``` - diff --git a/docs/v1/UsageDBMHour.md b/docs/v1/UsageDBMHour.md index 61fa3db87dd9..b2a32009b11a 100644 --- a/docs/v1/UsageDBMHour.md +++ b/docs/v1/UsageDBMHour.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **dbm_host_count** | **Integer** | The total number of Database Monitoring host hours from the start of the given hour’s month until the given hour. | [optional] | +| Name | Type | Description | Notes | +| --------------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **dbm_host_count** | **Integer** | The total number of Database Monitoring host hours from the start of the given hour’s month until the given hour. | [optional] | | **dbm_queries_count** | **Integer** | The total number of normalized Database Monitoring queries from the start of the given hour’s month until the given hour. | [optional] | -| **hour** | **Time** | The hour for the usage. | [optional] | +| **hour** | **Time** | The hour for the usage. | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::UsageDBMHour.new( hour: null ) ``` - diff --git a/docs/v1/UsageDBMResponse.md b/docs/v1/UsageDBMResponse.md index 864c5beebfdc..31f394806ba2 100644 --- a/docs/v1/UsageDBMResponse.md +++ b/docs/v1/UsageDBMResponse.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| --------- | ------------------------------------------------ | ---------------------------------------- | ---------- | | **usage** | [**Array<UsageDBMHour>**](UsageDBMHour.md) | Get hourly usage for Database Monitoring | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::UsageDBMResponse.new( usage: null ) ``` - diff --git a/docs/v1/UsageFargateHour.md b/docs/v1/UsageFargateHour.md index 2c435f1e0f14..224e266ff0eb 100644 --- a/docs/v1/UsageFargateHour.md +++ b/docs/v1/UsageFargateHour.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **hour** | **Time** | The hour for the usage. | [optional] | +| Name | Type | Description | Notes | +| --------------- | ----------- | -------------------------------- | ---------- | +| **hour** | **Time** | The hour for the usage. | [optional] | | **tasks_count** | **Integer** | The number of Fargate tasks run. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::UsageFargateHour.new( tasks_count: null ) ``` - diff --git a/docs/v1/UsageFargateResponse.md b/docs/v1/UsageFargateResponse.md index 92e2145a6d03..df6bd18e21e0 100644 --- a/docs/v1/UsageFargateResponse.md +++ b/docs/v1/UsageFargateResponse.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| --------- | -------------------------------------------------------- | -------------------------------------------------------------------------------- | ---------- | | **usage** | [**Array<UsageFargateHour>**](UsageFargateHour.md) | Array with the number of hourly Fargate tasks recorded for a given organization. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::UsageFargateResponse.new( usage: null ) ``` - diff --git a/docs/v1/UsageHostHour.md b/docs/v1/UsageHostHour.md index 0cf3fe0ab5a0..bf96a70de639 100644 --- a/docs/v1/UsageHostHour.md +++ b/docs/v1/UsageHostHour.md @@ -2,22 +2,22 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **agent_host_count** | **Integer** | Contains the total number of infrastructure hosts reporting during a given hour that were running the Datadog Agent. | [optional] | -| **alibaba_host_count** | **Integer** | Contains the total number of hosts that reported via Alibaba integration (and were NOT running the Datadog Agent). | [optional] | -| **apm_azure_app_service_host_count** | **Integer** | Contains the total number of Azure App Services hosts using APM. | [optional] | -| **apm_host_count** | **Integer** | Shows the total number of hosts using APM during the hour, these are counted as billable (except during trial periods). | [optional] | -| **aws_host_count** | **Integer** | Contains the total number of hosts that reported via the AWS integration (and were NOT running the Datadog Agent). | [optional] | -| **azure_host_count** | **Integer** | Contains the total number of hosts that reported via Azure integration (and were NOT running the Datadog Agent). | [optional] | -| **container_count** | **Integer** | Shows the total number of containers reported by the Docker integration during the hour. | [optional] | -| **gcp_host_count** | **Integer** | Contains the total number of hosts that reported via the Google Cloud integration (and were NOT running the Datadog Agent). | [optional] | -| **heroku_host_count** | **Integer** | Contains the total number of Heroku dynos reported by the Datadog Agent. | [optional] | -| **host_count** | **Integer** | Contains the total number of billable infrastructure hosts reporting during a given hour. This is the sum of `agent_host_count`, `aws_host_count`, and `gcp_host_count`. | [optional] | -| **hour** | **Time** | The hour for the usage. | [optional] | -| **infra_azure_app_service** | **Integer** | Contains the total number of hosts that reported via the Azure App Services integration (and were NOT running the Datadog Agent). | [optional] | -| **opentelemetry_host_count** | **Integer** | Contains the total number of hosts reported by Datadog exporter for the OpenTelemetry Collector. | [optional] | -| **vsphere_host_count** | **Integer** | Contains the total number of hosts that reported via vSphere integration (and were NOT running the Datadog Agent). | [optional] | +| Name | Type | Description | Notes | +| ------------------------------------ | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------- | +| **agent_host_count** | **Integer** | Contains the total number of infrastructure hosts reporting during a given hour that were running the Datadog Agent. | [optional] | +| **alibaba_host_count** | **Integer** | Contains the total number of hosts that reported via Alibaba integration (and were NOT running the Datadog Agent). | [optional] | +| **apm_azure_app_service_host_count** | **Integer** | Contains the total number of Azure App Services hosts using APM. | [optional] | +| **apm_host_count** | **Integer** | Shows the total number of hosts using APM during the hour, these are counted as billable (except during trial periods). | [optional] | +| **aws_host_count** | **Integer** | Contains the total number of hosts that reported via the AWS integration (and were NOT running the Datadog Agent). | [optional] | +| **azure_host_count** | **Integer** | Contains the total number of hosts that reported via Azure integration (and were NOT running the Datadog Agent). | [optional] | +| **container_count** | **Integer** | Shows the total number of containers reported by the Docker integration during the hour. | [optional] | +| **gcp_host_count** | **Integer** | Contains the total number of hosts that reported via the Google Cloud integration (and were NOT running the Datadog Agent). | [optional] | +| **heroku_host_count** | **Integer** | Contains the total number of Heroku dynos reported by the Datadog Agent. | [optional] | +| **host_count** | **Integer** | Contains the total number of billable infrastructure hosts reporting during a given hour. This is the sum of `agent_host_count`, `aws_host_count`, and `gcp_host_count`. | [optional] | +| **hour** | **Time** | The hour for the usage. | [optional] | +| **infra_azure_app_service** | **Integer** | Contains the total number of hosts that reported via the Azure App Services integration (and were NOT running the Datadog Agent). | [optional] | +| **opentelemetry_host_count** | **Integer** | Contains the total number of hosts reported by Datadog exporter for the OpenTelemetry Collector. | [optional] | +| **vsphere_host_count** | **Integer** | Contains the total number of hosts that reported via vSphere integration (and were NOT running the Datadog Agent). | [optional] | ## Example @@ -41,4 +41,3 @@ instance = DatadogAPIClient::V1::UsageHostHour.new( vsphere_host_count: null ) ``` - diff --git a/docs/v1/UsageHostsResponse.md b/docs/v1/UsageHostsResponse.md index 3072e9a1d1ab..bf17ff8cc216 100644 --- a/docs/v1/UsageHostsResponse.md +++ b/docs/v1/UsageHostsResponse.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| --------- | -------------------------------------------------- | ------------------------------------------ | ---------- | | **usage** | [**Array<UsageHostHour>**](UsageHostHour.md) | An array of objects related to host usage. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::UsageHostsResponse.new( usage: null ) ``` - diff --git a/docs/v1/UsageIncidentManagementHour.md b/docs/v1/UsageIncidentManagementHour.md index a59553f3db5d..b5f4b0278a2d 100644 --- a/docs/v1/UsageIncidentManagementHour.md +++ b/docs/v1/UsageIncidentManagementHour.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **hour** | **Time** | The hour for the usage. | [optional] | +| Name | Type | Description | Notes | +| ------------------------ | ----------- | ----------------------------------------------------------------------------------------------------------------- | ---------- | +| **hour** | **Time** | The hour for the usage. | [optional] | | **monthly_active_users** | **Integer** | Contains the total number monthly active users from the start of the given hour's month until the given hour. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::UsageIncidentManagementHour.new( monthly_active_users: null ) ``` - diff --git a/docs/v1/UsageIncidentManagementResponse.md b/docs/v1/UsageIncidentManagementResponse.md index 7fe948d37576..935a38cebf76 100644 --- a/docs/v1/UsageIncidentManagementResponse.md +++ b/docs/v1/UsageIncidentManagementResponse.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| --------- | ------------------------------------------------------------------------------ | ----------------------------------------- | ---------- | | **usage** | [**Array<UsageIncidentManagementHour>**](UsageIncidentManagementHour.md) | Get hourly usage for incident management. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::UsageIncidentManagementResponse.new( usage: null ) ``` - diff --git a/docs/v1/UsageIndexedSpansHour.md b/docs/v1/UsageIndexedSpansHour.md index bb65faba809e..5b337c2757be 100644 --- a/docs/v1/UsageIndexedSpansHour.md +++ b/docs/v1/UsageIndexedSpansHour.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **hour** | **Time** | The hour for the usage. | [optional] | +| Name | Type | Description | Notes | +| ------------------------ | ----------- | ------------------------------------- | ---------- | +| **hour** | **Time** | The hour for the usage. | [optional] | | **indexed_events_count** | **Integer** | Contains the number of spans indexed. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::UsageIndexedSpansHour.new( indexed_events_count: null ) ``` - diff --git a/docs/v1/UsageIndexedSpansResponse.md b/docs/v1/UsageIndexedSpansResponse.md index 05d984a2e532..2fedc22a52a4 100644 --- a/docs/v1/UsageIndexedSpansResponse.md +++ b/docs/v1/UsageIndexedSpansResponse.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| --------- | ------------------------------------------------------------------ | ------------------------------------------------------------------------ | ---------- | | **usage** | [**Array<UsageIndexedSpansHour>**](UsageIndexedSpansHour.md) | Array with the number of hourly traces indexed for a given organization. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::UsageIndexedSpansResponse.new( usage: null ) ``` - diff --git a/docs/v1/UsageIngestedSpansHour.md b/docs/v1/UsageIngestedSpansHour.md index ccfde87ff759..516f0fc769aa 100644 --- a/docs/v1/UsageIngestedSpansHour.md +++ b/docs/v1/UsageIngestedSpansHour.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **hour** | **Time** | The hour for the usage. | [optional] | +| Name | Type | Description | Notes | +| ------------------------- | ----------- | ---------------------------------------------------------------- | ---------- | +| **hour** | **Time** | The hour for the usage. | [optional] | | **ingested_events_bytes** | **Integer** | Contains the total number of bytes ingested during a given hour. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::UsageIngestedSpansHour.new( ingested_events_bytes: null ) ``` - diff --git a/docs/v1/UsageIngestedSpansResponse.md b/docs/v1/UsageIngestedSpansResponse.md index f72cdf75b849..363236982d8b 100644 --- a/docs/v1/UsageIngestedSpansResponse.md +++ b/docs/v1/UsageIngestedSpansResponse.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| --------- | -------------------------------------------------------------------- | ------------------------------------ | ---------- | | **usage** | [**Array<UsageIngestedSpansHour>**](UsageIngestedSpansHour.md) | Get hourly usage for ingested spans. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::UsageIngestedSpansResponse.new( usage: null ) ``` - diff --git a/docs/v1/UsageIoTHour.md b/docs/v1/UsageIoTHour.md index dcbd170c4a5e..df446d6a9b4a 100644 --- a/docs/v1/UsageIoTHour.md +++ b/docs/v1/UsageIoTHour.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **hour** | **Time** | The hour for the usage. | [optional] | +| Name | Type | Description | Notes | +| -------------------- | ----------- | ---------------------------------------------------- | ---------- | +| **hour** | **Time** | The hour for the usage. | [optional] | | **iot_device_count** | **Integer** | The total number of IoT devices during a given hour. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::UsageIoTHour.new( iot_device_count: null ) ``` - diff --git a/docs/v1/UsageIoTResponse.md b/docs/v1/UsageIoTResponse.md index ea29d8c9aa3f..f72b55dcd575 100644 --- a/docs/v1/UsageIoTResponse.md +++ b/docs/v1/UsageIoTResponse.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| --------- | ------------------------------------------------ | ------------------------- | ---------- | | **usage** | [**Array<UsageIoTHour>**](UsageIoTHour.md) | Get hourly usage for IoT. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::UsageIoTResponse.new( usage: null ) ``` - diff --git a/docs/v1/UsageLambdaHour.md b/docs/v1/UsageLambdaHour.md index 9bbf32806da5..4973ab992193 100644 --- a/docs/v1/UsageLambdaHour.md +++ b/docs/v1/UsageLambdaHour.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **func_count** | **Integer** | Contains the number of different functions for each region and AWS account. | [optional] | -| **hour** | **Time** | The hour for the usage. | [optional] | -| **invocations_sum** | **Integer** | Contains the sum of invocations of all functions. | [optional] | +| Name | Type | Description | Notes | +| ------------------- | ----------- | --------------------------------------------------------------------------- | ---------- | +| **func_count** | **Integer** | Contains the number of different functions for each region and AWS account. | [optional] | +| **hour** | **Time** | The hour for the usage. | [optional] | +| **invocations_sum** | **Integer** | Contains the sum of invocations of all functions. | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::UsageLambdaHour.new( invocations_sum: null ) ``` - diff --git a/docs/v1/UsageLambdaResponse.md b/docs/v1/UsageLambdaResponse.md index b6e04bba641e..b0f0b6eeca84 100644 --- a/docs/v1/UsageLambdaResponse.md +++ b/docs/v1/UsageLambdaResponse.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| --------- | ------------------------------------------------------ | ---------------------------- | ---------- | | **usage** | [**Array<UsageLambdaHour>**](UsageLambdaHour.md) | Get hourly usage for Lambda. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::UsageLambdaResponse.new( usage: null ) ``` - diff --git a/docs/v1/UsageLogsByIndexHour.md b/docs/v1/UsageLogsByIndexHour.md index b68ccecc2b7f..41bac115940e 100644 --- a/docs/v1/UsageLogsByIndexHour.md +++ b/docs/v1/UsageLogsByIndexHour.md @@ -2,13 +2,13 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| --------------- | ----------- | ------------------------------------------------------ | ---------- | | **event_count** | **Integer** | The total number of indexed logs for the queried hour. | [optional] | -| **hour** | **Time** | The hour for the usage. | [optional] | -| **index_id** | **String** | The index ID for this usage. | [optional] | -| **index_name** | **String** | The user specified name for this index ID. | [optional] | -| **retention** | **Integer** | The retention period (in days) for this index ID. | [optional] | +| **hour** | **Time** | The hour for the usage. | [optional] | +| **index_id** | **String** | The index ID for this usage. | [optional] | +| **index_name** | **String** | The user specified name for this index ID. | [optional] | +| **retention** | **Integer** | The retention period (in days) for this index ID. | [optional] | ## Example @@ -23,4 +23,3 @@ instance = DatadogAPIClient::V1::UsageLogsByIndexHour.new( retention: null ) ``` - diff --git a/docs/v1/UsageLogsByIndexResponse.md b/docs/v1/UsageLogsByIndexResponse.md index 33b9d17688c1..a9d98dffd7d2 100644 --- a/docs/v1/UsageLogsByIndexResponse.md +++ b/docs/v1/UsageLogsByIndexResponse.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| --------- | ---------------------------------------------------------------- | --------------------------------------------------------------------- | ---------- | | **usage** | [**Array<UsageLogsByIndexHour>**](UsageLogsByIndexHour.md) | An array of objects regarding hourly usage of logs by index response. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::UsageLogsByIndexResponse.new( usage: null ) ``` - diff --git a/docs/v1/UsageLogsByRetentionHour.md b/docs/v1/UsageLogsByRetentionHour.md index bc8725660263..46da7db333d8 100644 --- a/docs/v1/UsageLogsByRetentionHour.md +++ b/docs/v1/UsageLogsByRetentionHour.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **indexed_events_count** | **Integer** | Total logs indexed with this retention period during a given hour. | [optional] | -| **live_indexed_events_count** | **Integer** | Live logs indexed with this retention period during a given hour. | [optional] | -| **rehydrated_indexed_events_count** | **Integer** | Rehydrated logs indexed with this retention period during a given hour. | [optional] | -| **retention** | **String** | The retention period in days or \"custom\" for all custom retention usage. | [optional] | +| Name | Type | Description | Notes | +| ----------------------------------- | ----------- | ------------------------------------------------------------------------------------ | ---------- | +| **indexed_events_count** | **Integer** | Total logs indexed with this retention period during a given hour. | [optional] | +| **live_indexed_events_count** | **Integer** | Live logs indexed with this retention period during a given hour. | [optional] | +| **rehydrated_indexed_events_count** | **Integer** | Rehydrated logs indexed with this retention period during a given hour. | [optional] | +| **retention** | **String** | The retention period in days or \"custom\" for all custom retention usage. | [optional] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V1::UsageLogsByRetentionHour.new( retention: null ) ``` - diff --git a/docs/v1/UsageLogsByRetentionResponse.md b/docs/v1/UsageLogsByRetentionResponse.md index d166170ff824..4d30b8aed093 100644 --- a/docs/v1/UsageLogsByRetentionResponse.md +++ b/docs/v1/UsageLogsByRetentionResponse.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| --------- | ------------------------------------------------------------------------ | ------------------------------------------------------ | ---------- | | **usage** | [**Array<UsageLogsByRetentionHour>**](UsageLogsByRetentionHour.md) | Get hourly usage for indexed logs by retention period. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::UsageLogsByRetentionResponse.new( usage: null ) ``` - diff --git a/docs/v1/UsageLogsHour.md b/docs/v1/UsageLogsHour.md index ad92cdaa763e..ece3bc19c795 100644 --- a/docs/v1/UsageLogsHour.md +++ b/docs/v1/UsageLogsHour.md @@ -2,15 +2,15 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **billable_ingested_bytes** | **Integer** | Contains the number of billable log bytes ingested. | [optional] | -| **hour** | **Time** | The hour for the usage. | [optional] | -| **indexed_events_count** | **Integer** | Contains the number of log events indexed. | [optional] | -| **ingested_events_bytes** | **Integer** | Contains the number of log bytes ingested. | [optional] | -| **logs_live_indexed_count** | **Integer** | Contains the number of live log events indexed (data available as of December 1, 2020). | [optional] | -| **logs_live_ingested_bytes** | **Integer** | Contains the number of live log bytes ingested (data available as of December 1, 2020). | [optional] | -| **logs_rehydrated_indexed_count** | **Integer** | Contains the number of rehydrated log events indexed (data available as of December 1, 2020). | [optional] | +| Name | Type | Description | Notes | +| ---------------------------------- | ----------- | --------------------------------------------------------------------------------------------- | ---------- | +| **billable_ingested_bytes** | **Integer** | Contains the number of billable log bytes ingested. | [optional] | +| **hour** | **Time** | The hour for the usage. | [optional] | +| **indexed_events_count** | **Integer** | Contains the number of log events indexed. | [optional] | +| **ingested_events_bytes** | **Integer** | Contains the number of log bytes ingested. | [optional] | +| **logs_live_indexed_count** | **Integer** | Contains the number of live log events indexed (data available as of December 1, 2020). | [optional] | +| **logs_live_ingested_bytes** | **Integer** | Contains the number of live log bytes ingested (data available as of December 1, 2020). | [optional] | +| **logs_rehydrated_indexed_count** | **Integer** | Contains the number of rehydrated log events indexed (data available as of December 1, 2020). | [optional] | | **logs_rehydrated_ingested_bytes** | **Integer** | Contains the number of rehydrated log bytes ingested (data available as of December 1, 2020). | [optional] | ## Example @@ -29,4 +29,3 @@ instance = DatadogAPIClient::V1::UsageLogsHour.new( logs_rehydrated_ingested_bytes: null ) ``` - diff --git a/docs/v1/UsageLogsResponse.md b/docs/v1/UsageLogsResponse.md index 556aedc21a69..8d4e3d2b5f64 100644 --- a/docs/v1/UsageLogsResponse.md +++ b/docs/v1/UsageLogsResponse.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| --------- | -------------------------------------------------- | --------------------------------------------------- | ---------- | | **usage** | [**Array<UsageLogsHour>**](UsageLogsHour.md) | An array of objects regarding hourly usage of logs. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::UsageLogsResponse.new( usage: null ) ``` - diff --git a/docs/v1/UsageMeteringAPI.md b/docs/v1/UsageMeteringAPI.md index ce149c72001d..3a2f7bb2a75f 100644 --- a/docs/v1/UsageMeteringAPI.md +++ b/docs/v1/UsageMeteringAPI.md @@ -2,42 +2,41 @@ All URIs are relative to *https://api.datadoghq.com* -| Method | HTTP request | Description | -| ------ | ------------ | ----------- | -| [**get_daily_custom_reports**](UsageMeteringAPI.md#get_daily_custom_reports) | **GET** /api/v1/daily_custom_reports | Get the list of available daily custom reports | -| [**get_incident_management**](UsageMeteringAPI.md#get_incident_management) | **GET** /api/v1/usage/incident-management | Get hourly usage for incident management | -| [**get_ingested_spans**](UsageMeteringAPI.md#get_ingested_spans) | **GET** /api/v1/usage/ingested-spans | Get hourly usage for ingested spans | -| [**get_monthly_custom_reports**](UsageMeteringAPI.md#get_monthly_custom_reports) | **GET** /api/v1/monthly_custom_reports | Get the list of available monthly custom reports | -| [**get_specified_daily_custom_reports**](UsageMeteringAPI.md#get_specified_daily_custom_reports) | **GET** /api/v1/daily_custom_reports/{report_id} | Get specified daily custom reports | -| [**get_specified_monthly_custom_reports**](UsageMeteringAPI.md#get_specified_monthly_custom_reports) | **GET** /api/v1/monthly_custom_reports/{report_id} | Get specified monthly custom reports | -| [**get_usage_analyzed_logs**](UsageMeteringAPI.md#get_usage_analyzed_logs) | **GET** /api/v1/usage/analyzed_logs | Get hourly usage for analyzed logs | -| [**get_usage_attribution**](UsageMeteringAPI.md#get_usage_attribution) | **GET** /api/v1/usage/attribution | Get Usage Attribution | -| [**get_usage_audit_logs**](UsageMeteringAPI.md#get_usage_audit_logs) | **GET** /api/v1/usage/audit_logs | Get hourly usage for audit logs | -| [**get_usage_billable_summary**](UsageMeteringAPI.md#get_usage_billable_summary) | **GET** /api/v1/usage/billable-summary | Get billable usage across your account | -| [**get_usage_cloud_security_posture_management**](UsageMeteringAPI.md#get_usage_cloud_security_posture_management) | **GET** /api/v1/usage/cspm | Get hourly usage for CSPM | -| [**get_usage_cws**](UsageMeteringAPI.md#get_usage_cws) | **GET** /api/v1/usage/cws | Get hourly usage for Cloud Workload Security | -| [**get_usage_dbm**](UsageMeteringAPI.md#get_usage_dbm) | **GET** /api/v1/usage/dbm | Get hourly usage for Database Monitoring | -| [**get_usage_fargate**](UsageMeteringAPI.md#get_usage_fargate) | **GET** /api/v1/usage/fargate | Get hourly usage for Fargate | -| [**get_usage_hosts**](UsageMeteringAPI.md#get_usage_hosts) | **GET** /api/v1/usage/hosts | Get hourly usage for hosts and containers | -| [**get_usage_indexed_spans**](UsageMeteringAPI.md#get_usage_indexed_spans) | **GET** /api/v1/usage/indexed-spans | Get hourly usage for indexed spans | -| [**get_usage_internet_of_things**](UsageMeteringAPI.md#get_usage_internet_of_things) | **GET** /api/v1/usage/iot | Get hourly usage for IoT | -| [**get_usage_lambda**](UsageMeteringAPI.md#get_usage_lambda) | **GET** /api/v1/usage/aws_lambda | Get hourly usage for Lambda | -| [**get_usage_logs**](UsageMeteringAPI.md#get_usage_logs) | **GET** /api/v1/usage/logs | Get hourly usage for Logs | -| [**get_usage_logs_by_index**](UsageMeteringAPI.md#get_usage_logs_by_index) | **GET** /api/v1/usage/logs_by_index | Get hourly usage for Logs by Index | -| [**get_usage_logs_by_retention**](UsageMeteringAPI.md#get_usage_logs_by_retention) | **GET** /api/v1/usage/logs-by-retention | Get hourly logs usage by retention | -| [**get_usage_network_flows**](UsageMeteringAPI.md#get_usage_network_flows) | **GET** /api/v1/usage/network_flows | Get hourly usage for Network Flows | -| [**get_usage_network_hosts**](UsageMeteringAPI.md#get_usage_network_hosts) | **GET** /api/v1/usage/network_hosts | Get hourly usage for Network Hosts | -| [**get_usage_profiling**](UsageMeteringAPI.md#get_usage_profiling) | **GET** /api/v1/usage/profiling | Get hourly usage for profiled hosts | -| [**get_usage_rum_sessions**](UsageMeteringAPI.md#get_usage_rum_sessions) | **GET** /api/v1/usage/rum_sessions | Get hourly usage for RUM Sessions | -| [**get_usage_sds**](UsageMeteringAPI.md#get_usage_sds) | **GET** /api/v1/usage/sds | Get hourly usage for Sensitive Data Scanner | -| [**get_usage_snmp**](UsageMeteringAPI.md#get_usage_snmp) | **GET** /api/v1/usage/snmp | Get hourly usage for SNMP devices | -| [**get_usage_summary**](UsageMeteringAPI.md#get_usage_summary) | **GET** /api/v1/usage/summary | Get usage across your multi-org account | -| [**get_usage_synthetics**](UsageMeteringAPI.md#get_usage_synthetics) | **GET** /api/v1/usage/synthetics | Get hourly usage for Synthetics Checks | -| [**get_usage_synthetics_api**](UsageMeteringAPI.md#get_usage_synthetics_api) | **GET** /api/v1/usage/synthetics_api | Get hourly usage for Synthetics API Checks | -| [**get_usage_synthetics_browser**](UsageMeteringAPI.md#get_usage_synthetics_browser) | **GET** /api/v1/usage/synthetics_browser | Get hourly usage for Synthetics Browser Checks | -| [**get_usage_timeseries**](UsageMeteringAPI.md#get_usage_timeseries) | **GET** /api/v1/usage/timeseries | Get hourly usage for custom metrics | -| [**get_usage_top_avg_metrics**](UsageMeteringAPI.md#get_usage_top_avg_metrics) | **GET** /api/v1/usage/top_avg_metrics | Get all custom metrics by hourly average | - +| Method | HTTP request | Description | +| ------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------- | ------------------------------------------------ | +| [**get_daily_custom_reports**](UsageMeteringAPI.md#get_daily_custom_reports) | **GET** /api/v1/daily_custom_reports | Get the list of available daily custom reports | +| [**get_incident_management**](UsageMeteringAPI.md#get_incident_management) | **GET** /api/v1/usage/incident-management | Get hourly usage for incident management | +| [**get_ingested_spans**](UsageMeteringAPI.md#get_ingested_spans) | **GET** /api/v1/usage/ingested-spans | Get hourly usage for ingested spans | +| [**get_monthly_custom_reports**](UsageMeteringAPI.md#get_monthly_custom_reports) | **GET** /api/v1/monthly_custom_reports | Get the list of available monthly custom reports | +| [**get_specified_daily_custom_reports**](UsageMeteringAPI.md#get_specified_daily_custom_reports) | **GET** /api/v1/daily_custom_reports/{report_id} | Get specified daily custom reports | +| [**get_specified_monthly_custom_reports**](UsageMeteringAPI.md#get_specified_monthly_custom_reports) | **GET** /api/v1/monthly_custom_reports/{report_id} | Get specified monthly custom reports | +| [**get_usage_analyzed_logs**](UsageMeteringAPI.md#get_usage_analyzed_logs) | **GET** /api/v1/usage/analyzed_logs | Get hourly usage for analyzed logs | +| [**get_usage_attribution**](UsageMeteringAPI.md#get_usage_attribution) | **GET** /api/v1/usage/attribution | Get Usage Attribution | +| [**get_usage_audit_logs**](UsageMeteringAPI.md#get_usage_audit_logs) | **GET** /api/v1/usage/audit_logs | Get hourly usage for audit logs | +| [**get_usage_billable_summary**](UsageMeteringAPI.md#get_usage_billable_summary) | **GET** /api/v1/usage/billable-summary | Get billable usage across your account | +| [**get_usage_cloud_security_posture_management**](UsageMeteringAPI.md#get_usage_cloud_security_posture_management) | **GET** /api/v1/usage/cspm | Get hourly usage for CSPM | +| [**get_usage_cws**](UsageMeteringAPI.md#get_usage_cws) | **GET** /api/v1/usage/cws | Get hourly usage for Cloud Workload Security | +| [**get_usage_dbm**](UsageMeteringAPI.md#get_usage_dbm) | **GET** /api/v1/usage/dbm | Get hourly usage for Database Monitoring | +| [**get_usage_fargate**](UsageMeteringAPI.md#get_usage_fargate) | **GET** /api/v1/usage/fargate | Get hourly usage for Fargate | +| [**get_usage_hosts**](UsageMeteringAPI.md#get_usage_hosts) | **GET** /api/v1/usage/hosts | Get hourly usage for hosts and containers | +| [**get_usage_indexed_spans**](UsageMeteringAPI.md#get_usage_indexed_spans) | **GET** /api/v1/usage/indexed-spans | Get hourly usage for indexed spans | +| [**get_usage_internet_of_things**](UsageMeteringAPI.md#get_usage_internet_of_things) | **GET** /api/v1/usage/iot | Get hourly usage for IoT | +| [**get_usage_lambda**](UsageMeteringAPI.md#get_usage_lambda) | **GET** /api/v1/usage/aws_lambda | Get hourly usage for Lambda | +| [**get_usage_logs**](UsageMeteringAPI.md#get_usage_logs) | **GET** /api/v1/usage/logs | Get hourly usage for Logs | +| [**get_usage_logs_by_index**](UsageMeteringAPI.md#get_usage_logs_by_index) | **GET** /api/v1/usage/logs_by_index | Get hourly usage for Logs by Index | +| [**get_usage_logs_by_retention**](UsageMeteringAPI.md#get_usage_logs_by_retention) | **GET** /api/v1/usage/logs-by-retention | Get hourly logs usage by retention | +| [**get_usage_network_flows**](UsageMeteringAPI.md#get_usage_network_flows) | **GET** /api/v1/usage/network_flows | Get hourly usage for Network Flows | +| [**get_usage_network_hosts**](UsageMeteringAPI.md#get_usage_network_hosts) | **GET** /api/v1/usage/network_hosts | Get hourly usage for Network Hosts | +| [**get_usage_profiling**](UsageMeteringAPI.md#get_usage_profiling) | **GET** /api/v1/usage/profiling | Get hourly usage for profiled hosts | +| [**get_usage_rum_sessions**](UsageMeteringAPI.md#get_usage_rum_sessions) | **GET** /api/v1/usage/rum_sessions | Get hourly usage for RUM Sessions | +| [**get_usage_sds**](UsageMeteringAPI.md#get_usage_sds) | **GET** /api/v1/usage/sds | Get hourly usage for Sensitive Data Scanner | +| [**get_usage_snmp**](UsageMeteringAPI.md#get_usage_snmp) | **GET** /api/v1/usage/snmp | Get hourly usage for SNMP devices | +| [**get_usage_summary**](UsageMeteringAPI.md#get_usage_summary) | **GET** /api/v1/usage/summary | Get usage across your multi-org account | +| [**get_usage_synthetics**](UsageMeteringAPI.md#get_usage_synthetics) | **GET** /api/v1/usage/synthetics | Get hourly usage for Synthetics Checks | +| [**get_usage_synthetics_api**](UsageMeteringAPI.md#get_usage_synthetics_api) | **GET** /api/v1/usage/synthetics_api | Get hourly usage for Synthetics API Checks | +| [**get_usage_synthetics_browser**](UsageMeteringAPI.md#get_usage_synthetics_browser) | **GET** /api/v1/usage/synthetics_browser | Get hourly usage for Synthetics Browser Checks | +| [**get_usage_timeseries**](UsageMeteringAPI.md#get_usage_timeseries) | **GET** /api/v1/usage/timeseries | Get hourly usage for custom metrics | +| [**get_usage_top_avg_metrics**](UsageMeteringAPI.md#get_usage_top_avg_metrics) | **GET** /api/v1/usage/top_avg_metrics | Get all custom metrics by hourly average | ## get_daily_custom_reports @@ -91,12 +90,12 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **page_size** | **Integer** | The number of files to return in the response. `[default=60]`. | [optional] | -| **page_number** | **Integer** | The identifier of the first page to return. This parameter is used for the pagination feature `[default=0]`. | [optional] | -| **sort_dir** | **UsageSortDirection** | The direction to sort by: `[desc, asc]`. | [optional][default to 'desc'] | -| **sort** | **UsageSort** | The field to sort by: `[computed_on, size, start_date, end_date]`. | [optional][default to 'start_date'] | +| Name | Type | Description | Notes | +| --------------- | ---------------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- | +| **page_size** | **Integer** | The number of files to return in the response. `[default=60]`. | [optional] | +| **page_number** | **Integer** | The identifier of the first page to return. This parameter is used for the pagination feature `[default=0]`. | [optional] | +| **sort_dir** | **UsageSortDirection** | The direction to sort by: `[desc, asc]`. | [optional][default to 'desc'] | +| **sort** | **UsageSort** | The field to sort by: `[computed_on, size, start_date, end_date]`. | [optional][default to 'start_date'] | ### Return type @@ -111,7 +110,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 - ## get_incident_management > get_incident_management(start_hr, opts) @@ -157,10 +155,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. | | -| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. | [optional] | +| Name | Type | Description | Notes | +| ------------ | -------- | --------------------------------------------------------------------------------------------------------------------- | ---------- | +| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. | | +| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. | [optional] | ### Return type @@ -175,7 +173,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 - ## get_ingested_spans > get_ingested_spans(start_hr, opts) @@ -221,10 +218,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. | | -| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. | [optional] | +| Name | Type | Description | Notes | +| ------------ | -------- | --------------------------------------------------------------------------------------------------------------------- | ---------- | +| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. | | +| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. | [optional] | ### Return type @@ -239,7 +236,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 - ## get_monthly_custom_reports > get_monthly_custom_reports(opts) @@ -292,12 +288,12 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **page_size** | **Integer** | The number of files to return in the response `[default=60].` | [optional] | -| **page_number** | **Integer** | The identifier of the first page to return. This parameter is used for the pagination feature `[default=0]`. | [optional] | -| **sort_dir** | **UsageSortDirection** | The direction to sort by: `[desc, asc]`. | [optional][default to 'desc'] | -| **sort** | **UsageSort** | The field to sort by: `[computed_on, size, start_date, end_date]`. | [optional][default to 'start_date'] | +| Name | Type | Description | Notes | +| --------------- | ---------------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- | +| **page_size** | **Integer** | The number of files to return in the response `[default=60].` | [optional] | +| **page_number** | **Integer** | The identifier of the first page to return. This parameter is used for the pagination feature `[default=0]`. | [optional] | +| **sort_dir** | **UsageSortDirection** | The direction to sort by: `[desc, asc]`. | [optional][default to 'desc'] | +| **sort** | **UsageSort** | The field to sort by: `[computed_on, size, start_date, end_date]`. | [optional][default to 'start_date'] | ### Return type @@ -312,7 +308,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 - ## get_specified_daily_custom_reports > get_specified_daily_custom_reports(report_id) @@ -360,9 +355,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **report_id** | **String** | Date of the report in the format `YYYY-MM-DD`. | | +| Name | Type | Description | Notes | +| ------------- | ---------- | -------------------------------------------------------- | ----- | +| **report_id** | **String** | Date of the report in the format `YYYY-MM-DD`. | | ### Return type @@ -377,7 +372,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 - ## get_specified_monthly_custom_reports > get_specified_monthly_custom_reports(report_id) @@ -425,9 +419,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **report_id** | **String** | Date of the report in the format `YYYY-MM-DD`. | | +| Name | Type | Description | Notes | +| ------------- | ---------- | -------------------------------------------------------- | ----- | +| **report_id** | **String** | Date of the report in the format `YYYY-MM-DD`. | | ### Return type @@ -442,7 +436,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 - ## get_usage_analyzed_logs > get_usage_analyzed_logs(start_hr, opts) @@ -488,10 +481,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. | | -| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. | [optional] | +| Name | Type | Description | Notes | +| ------------ | -------- | --------------------------------------------------------------------------------------------------------------------- | ---------- | +| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. | | +| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. | [optional] | ### Return type @@ -506,7 +499,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 - ## get_usage_attribution > get_usage_attribution(start_month, fields, opts) @@ -561,14 +553,14 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **start_month** | **Time** | Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage beginning in this month. Maximum of 15 months ago. | | -| **fields** | **UsageAttributionSupportedMetrics** | Comma-separated list of usage types to return, or `*` for all usage types. | | -| **end_month** | **Time** | Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage ending this month. | [optional] | -| **sort_direction** | **UsageSortDirection** | The direction to sort by: `[desc, asc]`. | [optional][default to 'desc'] | -| **sort_name** | **UsageAttributionSort** | The field to sort by. | [optional][default to 'custom_timeseries_usage'] | -| **include_descendants** | **Boolean** | Include child org usage in the response. Defaults to false. | [optional][default to false] | +| Name | Type | Description | Notes | +| ----------------------- | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | +| **start_month** | **Time** | Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage beginning in this month. Maximum of 15 months ago. | | +| **fields** | **UsageAttributionSupportedMetrics** | Comma-separated list of usage types to return, or `\*` for all usage types. | | +| **end_month** | **Time** | Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage ending this month. | [optional] | +| **sort_direction** | **UsageSortDirection** | The direction to sort by: `[desc, asc]`. | [optional][default to 'desc'] | +| **sort_name** | **UsageAttributionSort** | The field to sort by. | [optional][default to 'custom_timeseries_usage'] | +| **include_descendants** | **Boolean** | Include child org usage in the response. Defaults to false. | [optional][default to false] | ### Return type @@ -583,7 +575,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 - ## get_usage_audit_logs > get_usage_audit_logs(start_hr, opts) @@ -629,10 +620,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. | | -| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. | [optional] | +| Name | Type | Description | Notes | +| ------------ | -------- | --------------------------------------------------------------------------------------------------------------------- | ---------- | +| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. | | +| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. | [optional] | ### Return type @@ -647,7 +638,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 - ## get_usage_billable_summary > get_usage_billable_summary(opts) @@ -692,8 +682,8 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| --------- | -------- | -------------------------------------------------------------------------------------------------------- | ---------- | | **month** | **Time** | Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage starting this month. | [optional] | ### Return type @@ -709,7 +699,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 - ## get_usage_cloud_security_posture_management > get_usage_cloud_security_posture_management(start_hr, opts) @@ -755,10 +744,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. | | -| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. | [optional] | +| Name | Type | Description | Notes | +| ------------ | -------- | --------------------------------------------------------------------------------------------------------------------- | ---------- | +| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. | | +| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. | [optional] | ### Return type @@ -773,7 +762,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 - ## get_usage_cws > get_usage_cws(start_hr, opts) @@ -819,10 +807,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. | | -| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. | [optional] | +| Name | Type | Description | Notes | +| ------------ | -------- | --------------------------------------------------------------------------------------------------------------------- | ---------- | +| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. | | +| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. | [optional] | ### Return type @@ -837,7 +825,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 - ## get_usage_dbm > get_usage_dbm(start_hr, opts) @@ -883,10 +870,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. | | -| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. | [optional] | +| Name | Type | Description | Notes | +| ------------ | -------- | --------------------------------------------------------------------------------------------------------------------- | ---------- | +| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. | | +| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. | [optional] | ### Return type @@ -901,7 +888,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 - ## get_usage_fargate > get_usage_fargate(start_hr, opts) @@ -947,10 +933,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. | | -| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. | [optional] | +| Name | Type | Description | Notes | +| ------------ | -------- | --------------------------------------------------------------------------------------------------------- | ---------- | +| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. | | +| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. | [optional] | ### Return type @@ -965,7 +951,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 - ## get_usage_hosts > get_usage_hosts(start_hr, opts) @@ -1011,10 +996,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. | | -| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. | [optional] | +| Name | Type | Description | Notes | +| ------------ | -------- | --------------------------------------------------------------------------------------------------------- | ---------- | +| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. | | +| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. | [optional] | ### Return type @@ -1029,7 +1014,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 - ## get_usage_indexed_spans > get_usage_indexed_spans(start_hr, opts) @@ -1075,10 +1059,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. | | -| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. | [optional] | +| Name | Type | Description | Notes | +| ------------ | -------- | --------------------------------------------------------------------------------------------------------------------- | ---------- | +| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. | | +| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. | [optional] | ### Return type @@ -1093,7 +1077,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 - ## get_usage_internet_of_things > get_usage_internet_of_things(start_hr, opts) @@ -1139,10 +1122,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. | | -| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. | [optional] | +| Name | Type | Description | Notes | +| ------------ | -------- | --------------------------------------------------------------------------------------------------------------------- | ---------- | +| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. | | +| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. | [optional] | ### Return type @@ -1157,7 +1140,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 - ## get_usage_lambda > get_usage_lambda(start_hr, opts) @@ -1203,10 +1185,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. | | -| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. | [optional] | +| Name | Type | Description | Notes | +| ------------ | -------- | --------------------------------------------------------------------------------------------------------- | ---------- | +| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. | | +| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. | [optional] | ### Return type @@ -1221,7 +1203,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 - ## get_usage_logs > get_usage_logs(start_hr, opts) @@ -1267,10 +1248,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. | | -| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. | [optional] | +| Name | Type | Description | Notes | +| ------------ | -------- | --------------------------------------------------------------------------------------------------------- | ---------- | +| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. | | +| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. | [optional] | ### Return type @@ -1285,7 +1266,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 - ## get_usage_logs_by_index > get_usage_logs_by_index(start_hr, opts) @@ -1332,11 +1312,11 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. | | -| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. | [optional] | -| **index_name** | **Array<String>** | Comma-separated list of log index names. | [optional] | +| Name | Type | Description | Notes | +| -------------- | ----------------------- | --------------------------------------------------------------------------------------------------------- | ---------- | +| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. | | +| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. | [optional] | +| **index_name** | **Array<String>** | Comma-separated list of log index names. | [optional] | ### Return type @@ -1351,7 +1331,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 - ## get_usage_logs_by_retention > get_usage_logs_by_retention(start_hr, opts) @@ -1397,10 +1376,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. | | -| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. | [optional] | +| Name | Type | Description | Notes | +| ------------ | -------- | --------------------------------------------------------------------------------------------------------------------- | ---------- | +| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. | | +| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. | [optional] | ### Return type @@ -1415,7 +1394,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 - ## get_usage_network_flows > get_usage_network_flows(start_hr, opts) @@ -1461,10 +1439,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. | | -| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. | [optional] | +| Name | Type | Description | Notes | +| ------------ | -------- | --------------------------------------------------------------------------------------------------------------------- | ---------- | +| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. | | +| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. | [optional] | ### Return type @@ -1479,7 +1457,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 - ## get_usage_network_hosts > get_usage_network_hosts(start_hr, opts) @@ -1525,10 +1502,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. | | -| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. | [optional] | +| Name | Type | Description | Notes | +| ------------ | -------- | --------------------------------------------------------------------------------------------------------- | ---------- | +| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. | | +| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. | [optional] | ### Return type @@ -1543,7 +1520,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 - ## get_usage_profiling > get_usage_profiling(start_hr, opts) @@ -1589,10 +1565,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. | | -| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. | [optional] | +| Name | Type | Description | Notes | +| ------------ | -------- | --------------------------------------------------------------------------------------------------------------------- | ---------- | +| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. | | +| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. | [optional] | ### Return type @@ -1607,7 +1583,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 - ## get_usage_rum_sessions > get_usage_rum_sessions(start_hr, opts) @@ -1654,11 +1629,11 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. | | -| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. | [optional] | -| **type** | **String** | RUM type: `[browser, mobile]`. Defaults to `browser`. | [optional] | +| Name | Type | Description | Notes | +| ------------ | ---------- | --------------------------------------------------------------------------------------------------------- | ---------- | +| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. | | +| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. | [optional] | +| **type** | **String** | RUM type: `[browser, mobile]`. Defaults to `browser`. | [optional] | ### Return type @@ -1673,7 +1648,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 - ## get_usage_sds > get_usage_sds(start_hr, opts) @@ -1719,10 +1693,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. | | -| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. | [optional] | +| Name | Type | Description | Notes | +| ------------ | -------- | --------------------------------------------------------------------------------------------------------------------- | ---------- | +| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. | | +| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. | [optional] | ### Return type @@ -1737,7 +1711,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 - ## get_usage_snmp > get_usage_snmp(start_hr, opts) @@ -1783,10 +1756,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. | | -| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. | [optional] | +| Name | Type | Description | Notes | +| ------------ | -------- | --------------------------------------------------------------------------------------------------------------------- | ---------- | +| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage beginning at this hour. | | +| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]` for usage ending **before** this hour. | [optional] | ### Return type @@ -1801,7 +1774,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 - ## get_usage_summary > get_usage_summary(start_month, opts) @@ -1848,11 +1820,11 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **start_month** | **Time** | Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage beginning in this month. Maximum of 15 months ago. | | -| **end_month** | **Time** | Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage ending this month. | [optional] | -| **include_org_details** | **Boolean** | Include usage summaries for each sub-org. | [optional] | +| Name | Type | Description | Notes | +| ----------------------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **start_month** | **Time** | Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage beginning in this month. Maximum of 15 months ago. | | +| **end_month** | **Time** | Datetime in ISO-8601 format, UTC, precise to month: `[YYYY-MM]` for usage ending this month. | [optional] | +| **include_org_details** | **Boolean** | Include usage summaries for each sub-org. | [optional] | ### Return type @@ -1867,7 +1839,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 - ## get_usage_synthetics > get_usage_synthetics(start_hr, opts) @@ -1913,10 +1884,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. | | -| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. | [optional] | +| Name | Type | Description | Notes | +| ------------ | -------- | --------------------------------------------------------------------------------------------------------- | ---------- | +| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. | | +| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. | [optional] | ### Return type @@ -1931,7 +1902,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 - ## get_usage_synthetics_api > get_usage_synthetics_api(start_hr, opts) @@ -1977,10 +1947,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. | | -| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. | [optional] | +| Name | Type | Description | Notes | +| ------------ | -------- | --------------------------------------------------------------------------------------------------------- | ---------- | +| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. | | +| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. | [optional] | ### Return type @@ -1995,7 +1965,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 - ## get_usage_synthetics_browser > get_usage_synthetics_browser(start_hr, opts) @@ -2041,10 +2010,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. | | -| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. | [optional] | +| Name | Type | Description | Notes | +| ------------ | -------- | --------------------------------------------------------------------------------------------------------- | ---------- | +| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. | | +| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. | [optional] | ### Return type @@ -2059,7 +2028,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 - ## get_usage_timeseries > get_usage_timeseries(start_hr, opts) @@ -2105,10 +2073,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. | | -| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. | [optional] | +| Name | Type | Description | Notes | +| ------------ | -------- | --------------------------------------------------------------------------------------------------------- | ---------- | +| **start_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage beginning at this hour. | | +| **end_hr** | **Time** | Datetime in ISO-8601 format, UTC, precise to hour: [YYYY-MM-DDThh] for usage ending **before** this hour. | [optional] | ### Return type @@ -2123,7 +2091,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 - ## get_usage_top_avg_metrics > get_usage_top_avg_metrics(opts) @@ -2172,13 +2139,13 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **month** | **Time** | Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM] for usage beginning at this hour. (Either month or day should be specified, but not both) | [optional] | -| **day** | **Time** | Datetime in ISO-8601 format, UTC, precise to day: [YYYY-MM-DD] for usage beginning at this hour. (Either month or day should be specified, but not both) | [optional] | -| **names** | **Array<String>** | Comma-separated list of metric names. | [optional] | -| **limit** | **Integer** | Maximum number of results to return (between 1 and 5000) - defaults to 500 results if limit not specified. | [optional][default to 500] | -| **next_record_id** | **String** | List following results with a next_record_id provided in the previous query. | [optional] | +| Name | Type | Description | Notes | +| ------------------ | ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------- | +| **month** | **Time** | Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM] for usage beginning at this hour. (Either month or day should be specified, but not both) | [optional] | +| **day** | **Time** | Datetime in ISO-8601 format, UTC, precise to day: [YYYY-MM-DD] for usage beginning at this hour. (Either month or day should be specified, but not both) | [optional] | +| **names** | **Array<String>** | Comma-separated list of metric names. | [optional] | +| **limit** | **Integer** | Maximum number of results to return (between 1 and 5000) - defaults to 500 results if limit not specified. | [optional][default to 500] | +| **next_record_id** | **String** | List following results with a next_record_id provided in the previous query. | [optional] | ### Return type @@ -2192,4 +2159,3 @@ end - **Content-Type**: Not defined - **Accept**: application/json;datetime-format=rfc3339 - diff --git a/docs/v1/UsageMetricCategory.md b/docs/v1/UsageMetricCategory.md index 7e8f423454e0..24d2373eefd5 100644 --- a/docs/v1/UsageMetricCategory.md +++ b/docs/v1/UsageMetricCategory.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::UsageMetricCategory.new() ``` - diff --git a/docs/v1/UsageNetworkFlowsHour.md b/docs/v1/UsageNetworkFlowsHour.md index b8dd3b11f218..10f0d15cb5bc 100644 --- a/docs/v1/UsageNetworkFlowsHour.md +++ b/docs/v1/UsageNetworkFlowsHour.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **hour** | **Time** | The hour for the usage. | [optional] | +| Name | Type | Description | Notes | +| ----------------------- | ----------- | ---------------------------------------------- | ---------- | +| **hour** | **Time** | The hour for the usage. | [optional] | | **indexed_event_count** | **Integer** | Contains the number of netflow events indexed. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::UsageNetworkFlowsHour.new( indexed_event_count: null ) ``` - diff --git a/docs/v1/UsageNetworkFlowsResponse.md b/docs/v1/UsageNetworkFlowsResponse.md index 38e504e6eaf5..d280a6098d2e 100644 --- a/docs/v1/UsageNetworkFlowsResponse.md +++ b/docs/v1/UsageNetworkFlowsResponse.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| --------- | ------------------------------------------------------------------ | ----------------------------------- | ---------- | | **usage** | [**Array<UsageNetworkFlowsHour>**](UsageNetworkFlowsHour.md) | Get hourly usage for Network Flows. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::UsageNetworkFlowsResponse.new( usage: null ) ``` - diff --git a/docs/v1/UsageNetworkHostsHour.md b/docs/v1/UsageNetworkHostsHour.md index 2c51093742dd..d9a2837fe4fb 100644 --- a/docs/v1/UsageNetworkHostsHour.md +++ b/docs/v1/UsageNetworkHostsHour.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| -------------- | ----------- | ---------------------------------------- | ---------- | | **host_count** | **Integer** | Contains the number of active NPM hosts. | [optional] | -| **hour** | **Time** | The hour for the usage. | [optional] | +| **hour** | **Time** | The hour for the usage. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::UsageNetworkHostsHour.new( hour: null ) ``` - diff --git a/docs/v1/UsageNetworkHostsResponse.md b/docs/v1/UsageNetworkHostsResponse.md index 3cedb601325c..214ff8933a7e 100644 --- a/docs/v1/UsageNetworkHostsResponse.md +++ b/docs/v1/UsageNetworkHostsResponse.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| --------- | ------------------------------------------------------------------ | ------------------------------- | ---------- | | **usage** | [**Array<UsageNetworkHostsHour>**](UsageNetworkHostsHour.md) | Get hourly usage for NPM hosts. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::UsageNetworkHostsResponse.new( usage: null ) ``` - diff --git a/docs/v1/UsageProfilingHour.md b/docs/v1/UsageProfilingHour.md index 6379093c3a25..d4b250a43119 100644 --- a/docs/v1/UsageProfilingHour.md +++ b/docs/v1/UsageProfilingHour.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **avg_container_agent_count** | **Integer** | Get average number of container agents for that hour. | [optional] | -| **host_count** | **Integer** | Contains the total number of profiled hosts reporting during a given hour. | [optional] | -| **hour** | **Time** | The hour for the usage. | [optional] | +| Name | Type | Description | Notes | +| ----------------------------- | ----------- | -------------------------------------------------------------------------- | ---------- | +| **avg_container_agent_count** | **Integer** | Get average number of container agents for that hour. | [optional] | +| **host_count** | **Integer** | Contains the total number of profiled hosts reporting during a given hour. | [optional] | +| **hour** | **Time** | The hour for the usage. | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::UsageProfilingHour.new( hour: null ) ``` - diff --git a/docs/v1/UsageProfilingResponse.md b/docs/v1/UsageProfilingResponse.md index 529aabdcb4bd..c97b334ab6a5 100644 --- a/docs/v1/UsageProfilingResponse.md +++ b/docs/v1/UsageProfilingResponse.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| --------- | ------------------------------------------------------------ | ------------------------------------ | ---------- | | **usage** | [**Array<UsageProfilingHour>**](UsageProfilingHour.md) | Get hourly usage for profiled hosts. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::UsageProfilingResponse.new( usage: null ) ``` - diff --git a/docs/v1/UsageReportsType.md b/docs/v1/UsageReportsType.md index 60c054f10f18..af366a3cd860 100644 --- a/docs/v1/UsageReportsType.md +++ b/docs/v1/UsageReportsType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::UsageReportsType.new() ``` - diff --git a/docs/v1/UsageRumSessionsHour.md b/docs/v1/UsageRumSessionsHour.md index c4e00db6f875..efed5ffc788b 100644 --- a/docs/v1/UsageRumSessionsHour.md +++ b/docs/v1/UsageRumSessionsHour.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **hour** | **Time** | The hour for the usage. | [optional] | -| **session_count** | **Integer** | Contains the number of RUM Sessions. | [optional] | +| Name | Type | Description | Notes | +| ------------------------- | ----------- | -------------------------------------------------------------------------------------------------- | ---------- | +| **hour** | **Time** | The hour for the usage. | [optional] | +| **session_count** | **Integer** | Contains the number of RUM Sessions. | [optional] | | **session_count_android** | **Integer** | Contains the number of mobile RUM Sessions on Android (data available beginning December 1, 2020). | [optional] | -| **session_count_ios** | **Integer** | Contains the number of mobile RUM Sessions on iOS (data available beginning December 1, 2020). | [optional] | +| **session_count_ios** | **Integer** | Contains the number of mobile RUM Sessions on iOS (data available beginning December 1, 2020). | [optional] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V1::UsageRumSessionsHour.new( session_count_ios: null ) ``` - diff --git a/docs/v1/UsageRumSessionsResponse.md b/docs/v1/UsageRumSessionsResponse.md index 27f01c8cb633..99f5964005da 100644 --- a/docs/v1/UsageRumSessionsResponse.md +++ b/docs/v1/UsageRumSessionsResponse.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| --------- | ---------------------------------------------------------------- | ---------------------------------- | ---------- | | **usage** | [**Array<UsageRumSessionsHour>**](UsageRumSessionsHour.md) | Get hourly usage for RUM Sessions. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::UsageRumSessionsResponse.new( usage: null ) ``` - diff --git a/docs/v1/UsageSDSHour.md b/docs/v1/UsageSDSHour.md index ee1621282bba..c56c36f46c20 100644 --- a/docs/v1/UsageSDSHour.md +++ b/docs/v1/UsageSDSHour.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **hour** | **Time** | The hour for the usage. | [optional] | -| **logs_scanned_bytes** | **Integer** | The total number of bytes scanned of logs usage by the Sensitive Data Scanner from the start of the given hour’s month until the given hour. | [optional] | +| Name | Type | Description | Notes | +| ----------------------- | ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **hour** | **Time** | The hour for the usage. | [optional] | +| **logs_scanned_bytes** | **Integer** | The total number of bytes scanned of logs usage by the Sensitive Data Scanner from the start of the given hour’s month until the given hour. | [optional] | | **total_scanned_bytes** | **Integer** | The total number of bytes scanned across all usage types by the Sensitive Data Scanner from the start of the given hour’s month until the given hour. | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::UsageSDSHour.new( total_scanned_bytes: null ) ``` - diff --git a/docs/v1/UsageSDSResponse.md b/docs/v1/UsageSDSResponse.md index de1652728662..5d06ec9dd406 100644 --- a/docs/v1/UsageSDSResponse.md +++ b/docs/v1/UsageSDSResponse.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| --------- | ------------------------------------------------ | -------------------------------------------- | ---------- | | **usage** | [**Array<UsageSDSHour>**](UsageSDSHour.md) | Get hourly usage for Sensitive Data Scanner. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::UsageSDSResponse.new( usage: null ) ``` - diff --git a/docs/v1/UsageSNMPHour.md b/docs/v1/UsageSNMPHour.md index 3ec32e197401..5a35ab790fe7 100644 --- a/docs/v1/UsageSNMPHour.md +++ b/docs/v1/UsageSNMPHour.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **hour** | **Time** | The hour for the usage. | [optional] | +| Name | Type | Description | Notes | +| ---------------- | ----------- | ------------------------------------ | ---------- | +| **hour** | **Time** | The hour for the usage. | [optional] | | **snmp_devices** | **Integer** | Contains the number of SNMP devices. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::UsageSNMPHour.new( snmp_devices: null ) ``` - diff --git a/docs/v1/UsageSNMPResponse.md b/docs/v1/UsageSNMPResponse.md index 620f086c5399..8c73d49fd654 100644 --- a/docs/v1/UsageSNMPResponse.md +++ b/docs/v1/UsageSNMPResponse.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| --------- | -------------------------------------------------- | ---------------------------------- | ---------- | | **usage** | [**Array<UsageSNMPHour>**](UsageSNMPHour.md) | Get hourly usage for SNMP devices. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::UsageSNMPResponse.new( usage: null ) ``` - diff --git a/docs/v1/UsageSort.md b/docs/v1/UsageSort.md index b2a3af14d164..ec9c49f64633 100644 --- a/docs/v1/UsageSort.md +++ b/docs/v1/UsageSort.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::UsageSort.new() ``` - diff --git a/docs/v1/UsageSortDirection.md b/docs/v1/UsageSortDirection.md index 3375e1be454a..c30d164d90b6 100644 --- a/docs/v1/UsageSortDirection.md +++ b/docs/v1/UsageSortDirection.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::UsageSortDirection.new() ``` - diff --git a/docs/v1/UsageSpecifiedCustomReportsAttributes.md b/docs/v1/UsageSpecifiedCustomReportsAttributes.md index f4e4ee5ebff6..6392e70c59e4 100644 --- a/docs/v1/UsageSpecifiedCustomReportsAttributes.md +++ b/docs/v1/UsageSpecifiedCustomReportsAttributes.md @@ -2,14 +2,14 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **computed_on** | **String** | The date the specified custom report was computed. | [optional] | -| **end_date** | **String** | The ending date of specified custom report. | [optional] | -| **location** | **String** | A downloadable file for the specified custom reporting file. | [optional] | -| **size** | **Integer** | size | [optional] | -| **start_date** | **String** | The starting date of specified custom report. | [optional] | -| **tags** | **Array<String>** | A list of tags to apply to specified custom reports. | [optional] | +| Name | Type | Description | Notes | +| --------------- | ----------------------- | ------------------------------------------------------------ | ---------- | +| **computed_on** | **String** | The date the specified custom report was computed. | [optional] | +| **end_date** | **String** | The ending date of specified custom report. | [optional] | +| **location** | **String** | A downloadable file for the specified custom reporting file. | [optional] | +| **size** | **Integer** | size | [optional] | +| **start_date** | **String** | The starting date of specified custom report. | [optional] | +| **tags** | **Array<String>** | A list of tags to apply to specified custom reports. | [optional] | ## Example @@ -25,4 +25,3 @@ instance = DatadogAPIClient::V1::UsageSpecifiedCustomReportsAttributes.new( tags: null ) ``` - diff --git a/docs/v1/UsageSpecifiedCustomReportsData.md b/docs/v1/UsageSpecifiedCustomReportsData.md index 3f4f06683aba..d852ca619174 100644 --- a/docs/v1/UsageSpecifiedCustomReportsData.md +++ b/docs/v1/UsageSpecifiedCustomReportsData.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**UsageSpecifiedCustomReportsAttributes**](UsageSpecifiedCustomReportsAttributes.md) | | [optional] | -| **id** | **String** | The date for specified custom reports. | [optional] | -| **type** | [**UsageReportsType**](UsageReportsType.md) | | [optional][default to 'reports'] | +| Name | Type | Description | Notes | +| -------------- | ------------------------------------------------------------------------------------- | -------------------------------------- | ---------------------------------------- | +| **attributes** | [**UsageSpecifiedCustomReportsAttributes**](UsageSpecifiedCustomReportsAttributes.md) | | [optional] | +| **id** | **String** | The date for specified custom reports. | [optional] | +| **type** | [**UsageReportsType**](UsageReportsType.md) | | [optional][default to 'reports'] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::UsageSpecifiedCustomReportsData.new( type: null ) ``` - diff --git a/docs/v1/UsageSpecifiedCustomReportsMeta.md b/docs/v1/UsageSpecifiedCustomReportsMeta.md index a4cddcc76da7..1f5e1933e9dc 100644 --- a/docs/v1/UsageSpecifiedCustomReportsMeta.md +++ b/docs/v1/UsageSpecifiedCustomReportsMeta.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **page** | [**UsageSpecifiedCustomReportsPage**](UsageSpecifiedCustomReportsPage.md) | | [optional] | +| Name | Type | Description | Notes | +| -------- | ------------------------------------------------------------------------- | ----------- | ---------- | +| **page** | [**UsageSpecifiedCustomReportsPage**](UsageSpecifiedCustomReportsPage.md) | | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::UsageSpecifiedCustomReportsMeta.new( page: null ) ``` - diff --git a/docs/v1/UsageSpecifiedCustomReportsPage.md b/docs/v1/UsageSpecifiedCustomReportsPage.md index d1b0a04ad2b9..b009863565f7 100644 --- a/docs/v1/UsageSpecifiedCustomReportsPage.md +++ b/docs/v1/UsageSpecifiedCustomReportsPage.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| --------------- | ----------- | ----------------- | ---------- | | **total_count** | **Integer** | Total page count. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::UsageSpecifiedCustomReportsPage.new( total_count: null ) ``` - diff --git a/docs/v1/UsageSpecifiedCustomReportsResponse.md b/docs/v1/UsageSpecifiedCustomReportsResponse.md index e7dbb3407d42..73dedc507c34 100644 --- a/docs/v1/UsageSpecifiedCustomReportsResponse.md +++ b/docs/v1/UsageSpecifiedCustomReportsResponse.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**UsageSpecifiedCustomReportsData**](UsageSpecifiedCustomReportsData.md) | | [optional] | -| **meta** | [**UsageSpecifiedCustomReportsMeta**](UsageSpecifiedCustomReportsMeta.md) | | [optional] | +| Name | Type | Description | Notes | +| -------- | ------------------------------------------------------------------------- | ----------- | ---------- | +| **data** | [**UsageSpecifiedCustomReportsData**](UsageSpecifiedCustomReportsData.md) | | [optional] | +| **meta** | [**UsageSpecifiedCustomReportsMeta**](UsageSpecifiedCustomReportsMeta.md) | | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::UsageSpecifiedCustomReportsResponse.new( meta: null ) ``` - diff --git a/docs/v1/UsageSummaryDate.md b/docs/v1/UsageSummaryDate.md index 93bb7f7e1e99..b9d96014d64a 100644 --- a/docs/v1/UsageSummaryDate.md +++ b/docs/v1/UsageSummaryDate.md @@ -2,55 +2,55 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **agent_host_top99p** | **Integer** | Shows the 99th percentile of all agent hosts over all hours in the current date for all organizations. | [optional] | -| **apm_azure_app_service_host_top99p** | **Integer** | Shows the 99th percentile of all Azure app services using APM over all hours in the current date all organizations. | [optional] | -| **apm_host_top99p** | **Integer** | Shows the 99th percentile of all distinct APM hosts over all hours in the current date for all organizations. | [optional] | -| **audit_logs_lines_indexed_sum** | **Integer** | Shows the sum of audit logs lines indexed over all hours in the current date for all organizations. | [optional] | -| **aws_host_top99p** | **Integer** | Shows the 99th percentile of all AWS hosts over all hours in the current date for all organizations. | [optional] | -| **aws_lambda_func_count** | **Integer** | Shows the average of the number of functions that executed 1 or more times each hour in the current date for all organizations. | [optional] | -| **aws_lambda_invocations_sum** | **Integer** | Shows the sum of all AWS Lambda invocations over all hours in the current date for all organizations. | [optional] | -| **azure_app_service_top99p** | **Integer** | Shows the 99th percentile of all Azure app services over all hours in the current date for all organizations. | [optional] | -| **billable_ingested_bytes_sum** | **Integer** | Shows the sum of all log bytes ingested over all hours in the current date for all organizations. | [optional] | -| **container_avg** | **Integer** | Shows the average of all distinct containers over all hours in the current date for all organizations. | [optional] | -| **container_hwm** | **Integer** | Shows the high-water mark of all distinct containers over all hours in the current date for all organizations. | [optional] | -| **cspm_container_avg** | **Integer** | Shows the average number of Cloud Security Posture Management containers over all hours in the current date for all organizations. | [optional] | -| **cspm_container_hwm** | **Integer** | Shows the high-water mark of Cloud Security Posture Management containers over all hours in the current date for all organizations. | [optional] | -| **cspm_host_top99p** | **Integer** | Shows the 99th percentile of all Cloud Security Posture Management hosts over all hours in the current date for all organizations. | [optional] | -| **custom_ts_avg** | **Integer** | Shows the average number of distinct custom metrics over all hours in the current date for all organizations. | [optional] | -| **cws_container_count_avg** | **Integer** | Shows the average of all distinct Cloud Workload Security containers over all hours in the current date for all organizations. | [optional] | -| **cws_host_top99p** | **Integer** | Shows the 99th percentile of all Cloud Workload Security hosts over all hours in the current date for all organizations. | [optional] | -| **date** | **Time** | The date for the usage. | [optional] | -| **dbm_host_top99p** | **Integer** | Shows the 99th percentile of all Database Monitoring hosts over all hours in the current date for all organizations. | [optional] | -| **dbm_queries_count_avg** | **Integer** | Shows the average of all normalized Database Monitoring queries over all hours in the current date for all organizations. | [optional] | -| **fargate_tasks_count_avg** | **Integer** | Shows the high-watermark of all Fargate tasks over all hours in the current date for all organizations. | [optional] | -| **fargate_tasks_count_hwm** | **Integer** | Shows the average of all Fargate tasks over all hours in the current date for all organizations. | [optional] | -| **gcp_host_top99p** | **Integer** | Shows the 99th percentile of all GCP hosts over all hours in the current date for all organizations. | [optional] | -| **heroku_host_top99p** | **Integer** | Shows the 99th percentile of all Heroku dynos over all hours in the current date for all organizations. | [optional] | -| **incident_management_monthly_active_users_hwm** | **Integer** | Shows the high-water mark of incident management monthly active users over all hours in the current date for all organizations. | [optional] | -| **indexed_events_count_sum** | **Integer** | Shows the sum of all log events indexed over all hours in the current date for all organizations. | [optional] | -| **infra_host_top99p** | **Integer** | Shows the 99th percentile of all distinct infrastructure hosts over all hours in the current date for all organizations. | [optional] | -| **ingested_events_bytes_sum** | **Integer** | Shows the sum of all log bytes ingested over all hours in the current date for all organizations. | [optional] | -| **iot_device_sum** | **Integer** | Shows the sum of all IoT devices over all hours in the current date for all organizations. | [optional] | -| **iot_device_top99p** | **Integer** | Shows the 99th percentile of all IoT devices over all hours in the current date all organizations. | [optional] | -| **mobile_rum_session_count_android_sum** | **Integer** | Shows the sum of all mobile RUM Sessions on Android over all hours in the current date for all organizations. | [optional] | -| **mobile_rum_session_count_ios_sum** | **Integer** | Shows the sum of all mobile RUM Sessions on iOS over all hours in the current date for all organizations. | [optional] | -| **mobile_rum_session_count_sum** | **Integer** | Shows the sum of all mobile RUM Sessions over all hours in the current date for all organizations | [optional] | -| **netflow_indexed_events_count_sum** | **Integer** | Shows the sum of all Network flows indexed over all hours in the current date for all organizations. | [optional] | -| **npm_host_top99p** | **Integer** | Shows the 99th percentile of all distinct Networks hosts over all hours in the current date for all organizations. | [optional] | -| **opentelemetry_host_top99p** | **Integer** | Shows the 99th percentile of all hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current date for all organizations. | [optional] | -| **orgs** | [**Array<UsageSummaryDateOrg>**](UsageSummaryDateOrg.md) | Organizations associated with a user. | [optional] | -| **profiling_host_top99p** | **Integer** | Shows the 99th percentile of all profiled hosts over all hours in the current date for all organizations. | [optional] | -| **rum_session_count_sum** | **Integer** | Shows the sum of all browser RUM Sessions over all hours in the current date for all organizations | [optional] | -| **rum_total_session_count_sum** | **Integer** | Shows the sum of RUM Sessions (browser and mobile) over all hours in the current date for all organizations. | [optional] | -| **sds_logs_scanned_bytes_sum** | **Integer** | Shows the sum of all bytes scanned of logs usage by the Sensitive Data Scanner over all hours in the current month for all organizations. | [optional] | -| **sds_total_scanned_bytes_sum** | **Integer** | Shows the sum of all bytes scanned across all usage types by the Sensitive Data Scanner over all hours in the current month for all organizations. | [optional] | -| **synthetics_browser_check_calls_count_sum** | **Integer** | Shows the sum of all Synthetic browser tests over all hours in the current date for all organizations. | [optional] | -| **synthetics_check_calls_count_sum** | **Integer** | Shows the sum of all Synthetic API tests over all hours in the current date for all organizations. | [optional] | -| **trace_search_indexed_events_count_sum** | **Integer** | Shows the sum of all Indexed Spans indexed over all hours in the current date for all organizations. | [optional] | -| **twol_ingested_events_bytes_sum** | **Integer** | Shows the sum of all tracing without limits bytes ingested over all hours in the current date for all organizations. | [optional] | -| **vsphere_host_top99p** | **Integer** | Shows the 99th percentile of all vSphere hosts over all hours in the current date for all organizations. | [optional] | +| Name | Type | Description | Notes | +| ------------------------------------------------ | -------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **agent_host_top99p** | **Integer** | Shows the 99th percentile of all agent hosts over all hours in the current date for all organizations. | [optional] | +| **apm_azure_app_service_host_top99p** | **Integer** | Shows the 99th percentile of all Azure app services using APM over all hours in the current date all organizations. | [optional] | +| **apm_host_top99p** | **Integer** | Shows the 99th percentile of all distinct APM hosts over all hours in the current date for all organizations. | [optional] | +| **audit_logs_lines_indexed_sum** | **Integer** | Shows the sum of audit logs lines indexed over all hours in the current date for all organizations. | [optional] | +| **aws_host_top99p** | **Integer** | Shows the 99th percentile of all AWS hosts over all hours in the current date for all organizations. | [optional] | +| **aws_lambda_func_count** | **Integer** | Shows the average of the number of functions that executed 1 or more times each hour in the current date for all organizations. | [optional] | +| **aws_lambda_invocations_sum** | **Integer** | Shows the sum of all AWS Lambda invocations over all hours in the current date for all organizations. | [optional] | +| **azure_app_service_top99p** | **Integer** | Shows the 99th percentile of all Azure app services over all hours in the current date for all organizations. | [optional] | +| **billable_ingested_bytes_sum** | **Integer** | Shows the sum of all log bytes ingested over all hours in the current date for all organizations. | [optional] | +| **container_avg** | **Integer** | Shows the average of all distinct containers over all hours in the current date for all organizations. | [optional] | +| **container_hwm** | **Integer** | Shows the high-water mark of all distinct containers over all hours in the current date for all organizations. | [optional] | +| **cspm_container_avg** | **Integer** | Shows the average number of Cloud Security Posture Management containers over all hours in the current date for all organizations. | [optional] | +| **cspm_container_hwm** | **Integer** | Shows the high-water mark of Cloud Security Posture Management containers over all hours in the current date for all organizations. | [optional] | +| **cspm_host_top99p** | **Integer** | Shows the 99th percentile of all Cloud Security Posture Management hosts over all hours in the current date for all organizations. | [optional] | +| **custom_ts_avg** | **Integer** | Shows the average number of distinct custom metrics over all hours in the current date for all organizations. | [optional] | +| **cws_container_count_avg** | **Integer** | Shows the average of all distinct Cloud Workload Security containers over all hours in the current date for all organizations. | [optional] | +| **cws_host_top99p** | **Integer** | Shows the 99th percentile of all Cloud Workload Security hosts over all hours in the current date for all organizations. | [optional] | +| **date** | **Time** | The date for the usage. | [optional] | +| **dbm_host_top99p** | **Integer** | Shows the 99th percentile of all Database Monitoring hosts over all hours in the current date for all organizations. | [optional] | +| **dbm_queries_count_avg** | **Integer** | Shows the average of all normalized Database Monitoring queries over all hours in the current date for all organizations. | [optional] | +| **fargate_tasks_count_avg** | **Integer** | Shows the high-watermark of all Fargate tasks over all hours in the current date for all organizations. | [optional] | +| **fargate_tasks_count_hwm** | **Integer** | Shows the average of all Fargate tasks over all hours in the current date for all organizations. | [optional] | +| **gcp_host_top99p** | **Integer** | Shows the 99th percentile of all GCP hosts over all hours in the current date for all organizations. | [optional] | +| **heroku_host_top99p** | **Integer** | Shows the 99th percentile of all Heroku dynos over all hours in the current date for all organizations. | [optional] | +| **incident_management_monthly_active_users_hwm** | **Integer** | Shows the high-water mark of incident management monthly active users over all hours in the current date for all organizations. | [optional] | +| **indexed_events_count_sum** | **Integer** | Shows the sum of all log events indexed over all hours in the current date for all organizations. | [optional] | +| **infra_host_top99p** | **Integer** | Shows the 99th percentile of all distinct infrastructure hosts over all hours in the current date for all organizations. | [optional] | +| **ingested_events_bytes_sum** | **Integer** | Shows the sum of all log bytes ingested over all hours in the current date for all organizations. | [optional] | +| **iot_device_sum** | **Integer** | Shows the sum of all IoT devices over all hours in the current date for all organizations. | [optional] | +| **iot_device_top99p** | **Integer** | Shows the 99th percentile of all IoT devices over all hours in the current date all organizations. | [optional] | +| **mobile_rum_session_count_android_sum** | **Integer** | Shows the sum of all mobile RUM Sessions on Android over all hours in the current date for all organizations. | [optional] | +| **mobile_rum_session_count_ios_sum** | **Integer** | Shows the sum of all mobile RUM Sessions on iOS over all hours in the current date for all organizations. | [optional] | +| **mobile_rum_session_count_sum** | **Integer** | Shows the sum of all mobile RUM Sessions over all hours in the current date for all organizations | [optional] | +| **netflow_indexed_events_count_sum** | **Integer** | Shows the sum of all Network flows indexed over all hours in the current date for all organizations. | [optional] | +| **npm_host_top99p** | **Integer** | Shows the 99th percentile of all distinct Networks hosts over all hours in the current date for all organizations. | [optional] | +| **opentelemetry_host_top99p** | **Integer** | Shows the 99th percentile of all hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current date for all organizations. | [optional] | +| **orgs** | [**Array<UsageSummaryDateOrg>**](UsageSummaryDateOrg.md) | Organizations associated with a user. | [optional] | +| **profiling_host_top99p** | **Integer** | Shows the 99th percentile of all profiled hosts over all hours in the current date for all organizations. | [optional] | +| **rum_session_count_sum** | **Integer** | Shows the sum of all browser RUM Sessions over all hours in the current date for all organizations | [optional] | +| **rum_total_session_count_sum** | **Integer** | Shows the sum of RUM Sessions (browser and mobile) over all hours in the current date for all organizations. | [optional] | +| **sds_logs_scanned_bytes_sum** | **Integer** | Shows the sum of all bytes scanned of logs usage by the Sensitive Data Scanner over all hours in the current month for all organizations. | [optional] | +| **sds_total_scanned_bytes_sum** | **Integer** | Shows the sum of all bytes scanned across all usage types by the Sensitive Data Scanner over all hours in the current month for all organizations. | [optional] | +| **synthetics_browser_check_calls_count_sum** | **Integer** | Shows the sum of all Synthetic browser tests over all hours in the current date for all organizations. | [optional] | +| **synthetics_check_calls_count_sum** | **Integer** | Shows the sum of all Synthetic API tests over all hours in the current date for all organizations. | [optional] | +| **trace_search_indexed_events_count_sum** | **Integer** | Shows the sum of all Indexed Spans indexed over all hours in the current date for all organizations. | [optional] | +| **twol_ingested_events_bytes_sum** | **Integer** | Shows the sum of all tracing without limits bytes ingested over all hours in the current date for all organizations. | [optional] | +| **vsphere_host_top99p** | **Integer** | Shows the 99th percentile of all vSphere hosts over all hours in the current date for all organizations. | [optional] | ## Example @@ -107,4 +107,3 @@ instance = DatadogAPIClient::V1::UsageSummaryDate.new( vsphere_host_top99p: null ) ``` - diff --git a/docs/v1/UsageSummaryDateOrg.md b/docs/v1/UsageSummaryDateOrg.md index 3bbc2826c6a8..d1c52f2c782b 100644 --- a/docs/v1/UsageSummaryDateOrg.md +++ b/docs/v1/UsageSummaryDateOrg.md @@ -2,56 +2,56 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **agent_host_top99p** | **Integer** | Shows the 99th percentile of all agent hosts over all hours in the current date for the given org. | [optional] | -| **apm_azure_app_service_host_top99p** | **Integer** | Shows the 99th percentile of all Azure app services using APM over all hours in the current date for the given org. | [optional] | -| **apm_host_top99p** | **Integer** | Shows the 99th percentile of all distinct APM hosts over all hours in the current date for the given org. | [optional] | -| **audit_logs_lines_indexed_sum** | **Integer** | Shows the sum of all audit logs lines indexed over all hours in the current date for the given org. | [optional] | -| **aws_host_top99p** | **Integer** | Shows the 99th percentile of all AWS hosts over all hours in the current date for the given org. | [optional] | -| **aws_lambda_func_count** | **Integer** | Shows the sum of all AWS Lambda invocations over all hours in the current date for the given org. | [optional] | -| **aws_lambda_invocations_sum** | **Integer** | Shows the sum of all AWS Lambda invocations over all hours in the current date for the given org. | [optional] | -| **azure_app_service_top99p** | **Integer** | Shows the 99th percentile of all Azure app services over all hours in the current date for the given org. | [optional] | -| **billable_ingested_bytes_sum** | **Integer** | Shows the sum of all log bytes ingested over all hours in the current date for the given org. | [optional] | -| **container_avg** | **Integer** | Shows the average of all distinct containers over all hours in the current date for the given org. | [optional] | -| **container_hwm** | **Integer** | Shows the high-water mark of all distinct containers over all hours in the current date for the given org. | [optional] | -| **cspm_container_avg** | **Integer** | Shows the average number of Cloud Security Posture Management containers over all hours in the current date for the given org. | [optional] | -| **cspm_container_hwm** | **Integer** | Shows the high-water mark of Cloud Security Posture Management containers over all hours in the current date for the given org. | [optional] | -| **cspm_host_top99p** | **Integer** | Shows the 99th percentile of all Cloud Security Posture Management hosts over all hours in the current date for the given org. | [optional] | -| **custom_ts_avg** | **Integer** | Shows the average number of distinct custom metrics over all hours in the current date for the given org. | [optional] | -| **cws_container_count_avg** | **Integer** | Shows the average of all distinct Cloud Workload Security containers over all hours in the current date for the given org. | [optional] | -| **cws_host_top99p** | **Integer** | Shows the 99th percentile of all Cloud Workload Security hosts over all hours in the current date for the given org. | [optional] | -| **dbm_host_top99p_sum** | **Integer** | Shows the 99th percentile of all Database Monitoring hosts over all hours in the current month for all organizations. | [optional] | -| **dbm_queries_avg_sum** | **Integer** | Shows the average of all distinct Database Monitoring normalized queries over all hours in the current month for all organizations. | [optional] | -| **fargate_tasks_count_avg** | **Integer** | The average task count for Fargate. | [optional] | -| **fargate_tasks_count_hwm** | **Integer** | Shows the high-water mark of all Fargate tasks over all hours in the current date for the given org. | [optional] | -| **gcp_host_top99p** | **Integer** | Shows the 99th percentile of all GCP hosts over all hours in the current date for the given org. | [optional] | -| **heroku_host_top99p** | **Integer** | Shows the 99th percentile of all Heroku dynos over all hours in the current date for the given org. | [optional] | -| **id** | **String** | The organization id. | [optional] | -| **incident_management_monthly_active_users_hwm** | **Integer** | Shows the high-water mark of incident management monthly active users over all hours in the current date for the given org. | [optional] | -| **indexed_events_count_sum** | **Integer** | Shows the sum of all log events indexed over all hours in the current date for the given org. | [optional] | -| **infra_host_top99p** | **Integer** | Shows the 99th percentile of all distinct infrastructure hosts over all hours in the current date for the given org. | [optional] | -| **ingested_events_bytes_sum** | **Integer** | Shows the sum of all log bytes ingested over all hours in the current date for the given org. | [optional] | -| **iot_device_agg_sum** | **Integer** | Shows the sum of all IoT devices over all hours in the current date for the given org. | [optional] | -| **iot_device_top99p_sum** | **Integer** | Shows the 99th percentile of all IoT devices over all hours in the current date for the given org. | [optional] | -| **mobile_rum_session_count_android_sum** | **Integer** | Shows the sum of all mobile RUM Sessions on Android over all hours in the current date for the given org. | [optional] | -| **mobile_rum_session_count_ios_sum** | **Integer** | Shows the sum of all mobile RUM Sessions on iOS over all hours in the current date for the given org. | [optional] | -| **mobile_rum_session_count_sum** | **Integer** | Shows the sum of all mobile RUM Sessions over all hours in the current date for the given org. | [optional] | -| **name** | **String** | The organization name. | [optional] | -| **netflow_indexed_events_count_sum** | **Integer** | Shows the sum of all Network flows indexed over all hours in the current date for the given org. | [optional] | -| **npm_host_top99p** | **Integer** | Shows the 99th percentile of all distinct Networks hosts over all hours in the current date for the given org. | [optional] | -| **opentelemetry_host_top99p** | **Integer** | Shows the 99th percentile of all hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current date for the given org. | [optional] | -| **profiling_host_top99p** | **Integer** | Shows the 99th percentile of all profiled hosts over all hours in the current date for the given org. | [optional] | -| **public_id** | **String** | The organization public id. | [optional] | -| **rum_session_count_sum** | **Integer** | Shows the sum of all browser RUM Sessions over all hours in the current date for the given org. | [optional] | -| **rum_total_session_count_sum** | **Integer** | Shows the sum of RUM Sessions (browser and mobile) over all hours in the current date for the given org. | [optional] | -| **sds_logs_scanned_bytes_sum** | **Integer** | Shows the sum of all bytes scanned of logs usage by the Sensitive Data Scanner over all hours in the current month for all organizations. | [optional] | -| **sds_total_scanned_bytes_sum** | **Integer** | Shows the sum of all bytes scanned across all usage types by the Sensitive Data Scanner over all hours in the current month for all organizations. | [optional] | -| **synthetics_browser_check_calls_count_sum** | **Integer** | Shows the sum of all Synthetic browser tests over all hours in the current date for the given org. | [optional] | -| **synthetics_check_calls_count_sum** | **Integer** | Shows the sum of all Synthetic API tests over all hours in the current date for the given org. | [optional] | -| **trace_search_indexed_events_count_sum** | **Integer** | Shows the sum of all Indexed Spans indexed over all hours in the current date for the given org. | [optional] | -| **twol_ingested_events_bytes_sum** | **Integer** | Shows the sum of all tracing without limits bytes ingested over all hours in the current date for the given org. | [optional] | -| **vsphere_host_top99p** | **Integer** | Shows the 99th percentile of all vSphere hosts over all hours in the current date for the given org. | [optional] | +| Name | Type | Description | Notes | +| ------------------------------------------------ | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **agent_host_top99p** | **Integer** | Shows the 99th percentile of all agent hosts over all hours in the current date for the given org. | [optional] | +| **apm_azure_app_service_host_top99p** | **Integer** | Shows the 99th percentile of all Azure app services using APM over all hours in the current date for the given org. | [optional] | +| **apm_host_top99p** | **Integer** | Shows the 99th percentile of all distinct APM hosts over all hours in the current date for the given org. | [optional] | +| **audit_logs_lines_indexed_sum** | **Integer** | Shows the sum of all audit logs lines indexed over all hours in the current date for the given org. | [optional] | +| **aws_host_top99p** | **Integer** | Shows the 99th percentile of all AWS hosts over all hours in the current date for the given org. | [optional] | +| **aws_lambda_func_count** | **Integer** | Shows the sum of all AWS Lambda invocations over all hours in the current date for the given org. | [optional] | +| **aws_lambda_invocations_sum** | **Integer** | Shows the sum of all AWS Lambda invocations over all hours in the current date for the given org. | [optional] | +| **azure_app_service_top99p** | **Integer** | Shows the 99th percentile of all Azure app services over all hours in the current date for the given org. | [optional] | +| **billable_ingested_bytes_sum** | **Integer** | Shows the sum of all log bytes ingested over all hours in the current date for the given org. | [optional] | +| **container_avg** | **Integer** | Shows the average of all distinct containers over all hours in the current date for the given org. | [optional] | +| **container_hwm** | **Integer** | Shows the high-water mark of all distinct containers over all hours in the current date for the given org. | [optional] | +| **cspm_container_avg** | **Integer** | Shows the average number of Cloud Security Posture Management containers over all hours in the current date for the given org. | [optional] | +| **cspm_container_hwm** | **Integer** | Shows the high-water mark of Cloud Security Posture Management containers over all hours in the current date for the given org. | [optional] | +| **cspm_host_top99p** | **Integer** | Shows the 99th percentile of all Cloud Security Posture Management hosts over all hours in the current date for the given org. | [optional] | +| **custom_ts_avg** | **Integer** | Shows the average number of distinct custom metrics over all hours in the current date for the given org. | [optional] | +| **cws_container_count_avg** | **Integer** | Shows the average of all distinct Cloud Workload Security containers over all hours in the current date for the given org. | [optional] | +| **cws_host_top99p** | **Integer** | Shows the 99th percentile of all Cloud Workload Security hosts over all hours in the current date for the given org. | [optional] | +| **dbm_host_top99p_sum** | **Integer** | Shows the 99th percentile of all Database Monitoring hosts over all hours in the current month for all organizations. | [optional] | +| **dbm_queries_avg_sum** | **Integer** | Shows the average of all distinct Database Monitoring normalized queries over all hours in the current month for all organizations. | [optional] | +| **fargate_tasks_count_avg** | **Integer** | The average task count for Fargate. | [optional] | +| **fargate_tasks_count_hwm** | **Integer** | Shows the high-water mark of all Fargate tasks over all hours in the current date for the given org. | [optional] | +| **gcp_host_top99p** | **Integer** | Shows the 99th percentile of all GCP hosts over all hours in the current date for the given org. | [optional] | +| **heroku_host_top99p** | **Integer** | Shows the 99th percentile of all Heroku dynos over all hours in the current date for the given org. | [optional] | +| **id** | **String** | The organization id. | [optional] | +| **incident_management_monthly_active_users_hwm** | **Integer** | Shows the high-water mark of incident management monthly active users over all hours in the current date for the given org. | [optional] | +| **indexed_events_count_sum** | **Integer** | Shows the sum of all log events indexed over all hours in the current date for the given org. | [optional] | +| **infra_host_top99p** | **Integer** | Shows the 99th percentile of all distinct infrastructure hosts over all hours in the current date for the given org. | [optional] | +| **ingested_events_bytes_sum** | **Integer** | Shows the sum of all log bytes ingested over all hours in the current date for the given org. | [optional] | +| **iot_device_agg_sum** | **Integer** | Shows the sum of all IoT devices over all hours in the current date for the given org. | [optional] | +| **iot_device_top99p_sum** | **Integer** | Shows the 99th percentile of all IoT devices over all hours in the current date for the given org. | [optional] | +| **mobile_rum_session_count_android_sum** | **Integer** | Shows the sum of all mobile RUM Sessions on Android over all hours in the current date for the given org. | [optional] | +| **mobile_rum_session_count_ios_sum** | **Integer** | Shows the sum of all mobile RUM Sessions on iOS over all hours in the current date for the given org. | [optional] | +| **mobile_rum_session_count_sum** | **Integer** | Shows the sum of all mobile RUM Sessions over all hours in the current date for the given org. | [optional] | +| **name** | **String** | The organization name. | [optional] | +| **netflow_indexed_events_count_sum** | **Integer** | Shows the sum of all Network flows indexed over all hours in the current date for the given org. | [optional] | +| **npm_host_top99p** | **Integer** | Shows the 99th percentile of all distinct Networks hosts over all hours in the current date for the given org. | [optional] | +| **opentelemetry_host_top99p** | **Integer** | Shows the 99th percentile of all hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current date for the given org. | [optional] | +| **profiling_host_top99p** | **Integer** | Shows the 99th percentile of all profiled hosts over all hours in the current date for the given org. | [optional] | +| **public_id** | **String** | The organization public id. | [optional] | +| **rum_session_count_sum** | **Integer** | Shows the sum of all browser RUM Sessions over all hours in the current date for the given org. | [optional] | +| **rum_total_session_count_sum** | **Integer** | Shows the sum of RUM Sessions (browser and mobile) over all hours in the current date for the given org. | [optional] | +| **sds_logs_scanned_bytes_sum** | **Integer** | Shows the sum of all bytes scanned of logs usage by the Sensitive Data Scanner over all hours in the current month for all organizations. | [optional] | +| **sds_total_scanned_bytes_sum** | **Integer** | Shows the sum of all bytes scanned across all usage types by the Sensitive Data Scanner over all hours in the current month for all organizations. | [optional] | +| **synthetics_browser_check_calls_count_sum** | **Integer** | Shows the sum of all Synthetic browser tests over all hours in the current date for the given org. | [optional] | +| **synthetics_check_calls_count_sum** | **Integer** | Shows the sum of all Synthetic API tests over all hours in the current date for the given org. | [optional] | +| **trace_search_indexed_events_count_sum** | **Integer** | Shows the sum of all Indexed Spans indexed over all hours in the current date for the given org. | [optional] | +| **twol_ingested_events_bytes_sum** | **Integer** | Shows the sum of all tracing without limits bytes ingested over all hours in the current date for the given org. | [optional] | +| **vsphere_host_top99p** | **Integer** | Shows the 99th percentile of all vSphere hosts over all hours in the current date for the given org. | [optional] | ## Example @@ -109,4 +109,3 @@ instance = DatadogAPIClient::V1::UsageSummaryDateOrg.new( vsphere_host_top99p: null ) ``` - diff --git a/docs/v1/UsageSummaryResponse.md b/docs/v1/UsageSummaryResponse.md index 678a6c5f12e1..f958ed3b225e 100644 --- a/docs/v1/UsageSummaryResponse.md +++ b/docs/v1/UsageSummaryResponse.md @@ -2,64 +2,64 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **agent_host_top99p_sum** | **Integer** | Shows the 99th percentile of all agent hosts over all hours in the current months for all organizations. | [optional] | -| **apm_azure_app_service_host_top99p_sum** | **Integer** | Shows the 99th percentile of all Azure app services using APM over all hours in the current months all organizations. | [optional] | -| **apm_host_top99p_sum** | **Integer** | Shows the 99th percentile of all distinct APM hosts over all hours in the current months for all organizations. | [optional] | -| **audit_logs_lines_indexed_agg_sum** | **Integer** | Shows the sum of all audit logs lines indexed over all hours in the current months for all organizations. | [optional] | -| **aws_host_top99p_sum** | **Integer** | Shows the 99th percentile of all AWS hosts over all hours in the current months for all organizations. | [optional] | -| **aws_lambda_func_count** | **Integer** | Shows the average of the number of functions that executed 1 or more times each hour in the current months for all organizations. | [optional] | -| **aws_lambda_invocations_sum** | **Integer** | Shows the sum of all AWS Lambda invocations over all hours in the current months for all organizations. | [optional] | -| **azure_app_service_top99p_sum** | **Integer** | Shows the 99th percentile of all Azure app services over all hours in the current months for all organizations. | [optional] | -| **azure_host_top99p_sum** | **Integer** | Shows the 99th percentile of all Azure hosts over all hours in the current months for all organizations. | [optional] | -| **billable_ingested_bytes_agg_sum** | **Integer** | Shows the sum of all log bytes ingested over all hours in the current months for all organizations. | [optional] | -| **container_avg_sum** | **Integer** | Shows the average of all distinct containers over all hours in the current months for all organizations. | [optional] | -| **container_hwm_sum** | **Integer** | Shows the sum of the high-water marks of all distinct containers over all hours in the current months for all organizations. | [optional] | -| **cspm_container_avg_sum** | **Integer** | Shows the average number of Cloud Security Posture Management containers over all hours in the current months for all organizations. | [optional] | -| **cspm_container_hwm_sum** | **Integer** | Shows the sum of the the high-water marks of Cloud Security Posture Management containers over all hours in the current months for all organizations. | [optional] | -| **cspm_host_top99p_sum** | **Integer** | Shows the 99th percentile of all Cloud Security Posture Management hosts over all hours in the current months for all organizations. | [optional] | -| **custom_ts_sum** | **Integer** | Shows the average number of distinct custom metrics over all hours in the current months for all organizations. | [optional] | -| **cws_containers_avg_sum** | **Integer** | Shows the average of all distinct Cloud Workload Security containers over all hours in the current months for all organizations. | [optional] | -| **cws_host_top99p_sum** | **Integer** | Shows the 99th percentile of all Cloud Workload Security hosts over all hours in the current months for all organizations. | [optional] | -| **dbm_host_top99p_sum** | **Integer** | Shows the 99th percentile of all Database Monitoring hosts over all hours in the current month for all organizations. | [optional] | -| **dbm_queries_avg_sum** | **Integer** | Shows the average of all distinct Database Monitoring Normalized Queries over all hours in the current month for all organizations. | [optional] | -| **end_date** | **Time** | Shows the last date of usage in the current months for all organizations. | [optional] | -| **fargate_tasks_count_avg_sum** | **Integer** | Shows the average of all Fargate tasks over all hours in the current months for all organizations. | [optional] | -| **fargate_tasks_count_hwm_sum** | **Integer** | Shows the sum of the high-water marks of all Fargate tasks over all hours in the current months for all organizations. | [optional] | -| **gcp_host_top99p_sum** | **Integer** | Shows the 99th percentile of all GCP hosts over all hours in the current months for all organizations. | [optional] | -| **heroku_host_top99p_sum** | **Integer** | Shows the 99th percentile of all Heroku dynos over all hours in the current months for all organizations. | [optional] | -| **incident_management_monthly_active_users_hwm_sum** | **Integer** | Shows sum of the the high-water marks of incident management monthly active users in the current months for all organizations. | [optional] | -| **indexed_events_count_agg_sum** | **Integer** | Shows the sum of all log events indexed over all hours in the current months for all organizations. | [optional] | -| **infra_host_top99p_sum** | **Integer** | Shows the 99th percentile of all distinct infrastructure hosts over all hours in the current months for all organizations. | [optional] | -| **ingested_events_bytes_agg_sum** | **Integer** | Shows the sum of all log bytes ingested over all hours in the current months for all organizations. | [optional] | -| **iot_device_agg_sum** | **Integer** | Shows the sum of all IoT devices over all hours in the current months for all organizations. | [optional] | -| **iot_device_top99p_sum** | **Integer** | Shows the 99th percentile of all IoT devices over all hours in the current months of all organizations. | [optional] | -| **last_updated** | **Time** | Shows the the most recent hour in the current months for all organizations for which all usages were calculated. | [optional] | -| **live_indexed_events_agg_sum** | **Integer** | Shows the sum of all live logs indexed over all hours in the current months for all organizations (data available as of December 1, 2020). | [optional] | -| **live_ingested_bytes_agg_sum** | **Integer** | Shows the sum of all live logs bytes ingested over all hours in the current months for all organizations (data available as of December 1, 2020). | [optional] | -| **logs_by_retention** | [**LogsByRetention**](LogsByRetention.md) | | [optional] | -| **mobile_rum_session_count_agg_sum** | **Integer** | Shows the sum of all mobile RUM Sessions over all hours in the current months for all organizations. | [optional] | -| **mobile_rum_session_count_android_agg_sum** | **Integer** | Shows the sum of all mobile RUM Sessions on Android over all hours in the current months for all organizations. | [optional] | -| **mobile_rum_session_count_ios_agg_sum** | **Integer** | Shows the sum of all mobile RUM Sessions on iOS over all hours in the current months for all organizations. | [optional] | -| **netflow_indexed_events_count_agg_sum** | **Integer** | Shows the sum of all Network flows indexed over all hours in the current months for all organizations. | [optional] | -| **npm_host_top99p_sum** | **Integer** | Shows the 99th percentile of all distinct Networks hosts over all hours in the current months for all organizations. | [optional] | -| **opentelemetry_host_top99p_sum** | **Integer** | Shows the 99th percentile of all hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current months for all organizations. | [optional] | -| **profiling_container_agent_count_avg** | **Integer** | Shows the average number of profiled containers over all hours in the current months for all organizations. | [optional] | -| **profiling_host_count_top99p_sum** | **Integer** | Shows the 99th percentile of all profiled hosts over all hours in the current months for all organizations. | [optional] | -| **rehydrated_indexed_events_agg_sum** | **Integer** | Shows the sum of all rehydrated logs indexed over all hours in the current months for all organizations (data available as of December 1, 2020). | [optional] | -| **rehydrated_ingested_bytes_agg_sum** | **Integer** | Shows the sum of all rehydrated logs bytes ingested over all hours in the current months for all organizations (data available as of December 1, 2020). | [optional] | -| **rum_session_count_agg_sum** | **Integer** | Shows the sum of all browser RUM Sessions over all hours in the current months for all organizations. | [optional] | -| **rum_total_session_count_agg_sum** | **Integer** | Shows the sum of RUM Sessions (browser and mobile) over all hours in the current months for all organizations. | [optional] | -| **sds_logs_scanned_bytes_sum** | **Integer** | Shows the sum of all bytes scanned of logs usage by the Sensitive Data Scanner over all hours in the current month for all organizations. | [optional] | -| **sds_total_scanned_bytes_sum** | **Integer** | Shows the sum of all bytes scanned across all usage types by the Sensitive Data Scanner over all hours in the current month for all organizations. | [optional] | -| **start_date** | **Time** | Shows the first date of usage in the current months for all organizations. | [optional] | -| **synthetics_browser_check_calls_count_agg_sum** | **Integer** | Shows the sum of all Synthetic browser tests over all hours in the current months for all organizations. | [optional] | -| **synthetics_check_calls_count_agg_sum** | **Integer** | Shows the sum of all Synthetic API tests over all hours in the current months for all organizations. | [optional] | -| **trace_search_indexed_events_count_agg_sum** | **Integer** | Shows the sum of all Indexed Spans indexed over all hours in the current months for all organizations. | [optional] | -| **twol_ingested_events_bytes_agg_sum** | **Integer** | Shows the sum of all tracing without limits bytes ingested over all hours in the current months for all organizations. | [optional] | -| **usage** | [**Array<UsageSummaryDate>**](UsageSummaryDate.md) | An array of objects regarding hourly usage. | [optional] | -| **vsphere_host_top99p_sum** | **Integer** | Shows the 99th percentile of all vSphere hosts over all hours in the current months for all organizations. | [optional] | +| Name | Type | Description | Notes | +| ---------------------------------------------------- | -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **agent_host_top99p_sum** | **Integer** | Shows the 99th percentile of all agent hosts over all hours in the current months for all organizations. | [optional] | +| **apm_azure_app_service_host_top99p_sum** | **Integer** | Shows the 99th percentile of all Azure app services using APM over all hours in the current months all organizations. | [optional] | +| **apm_host_top99p_sum** | **Integer** | Shows the 99th percentile of all distinct APM hosts over all hours in the current months for all organizations. | [optional] | +| **audit_logs_lines_indexed_agg_sum** | **Integer** | Shows the sum of all audit logs lines indexed over all hours in the current months for all organizations. | [optional] | +| **aws_host_top99p_sum** | **Integer** | Shows the 99th percentile of all AWS hosts over all hours in the current months for all organizations. | [optional] | +| **aws_lambda_func_count** | **Integer** | Shows the average of the number of functions that executed 1 or more times each hour in the current months for all organizations. | [optional] | +| **aws_lambda_invocations_sum** | **Integer** | Shows the sum of all AWS Lambda invocations over all hours in the current months for all organizations. | [optional] | +| **azure_app_service_top99p_sum** | **Integer** | Shows the 99th percentile of all Azure app services over all hours in the current months for all organizations. | [optional] | +| **azure_host_top99p_sum** | **Integer** | Shows the 99th percentile of all Azure hosts over all hours in the current months for all organizations. | [optional] | +| **billable_ingested_bytes_agg_sum** | **Integer** | Shows the sum of all log bytes ingested over all hours in the current months for all organizations. | [optional] | +| **container_avg_sum** | **Integer** | Shows the average of all distinct containers over all hours in the current months for all organizations. | [optional] | +| **container_hwm_sum** | **Integer** | Shows the sum of the high-water marks of all distinct containers over all hours in the current months for all organizations. | [optional] | +| **cspm_container_avg_sum** | **Integer** | Shows the average number of Cloud Security Posture Management containers over all hours in the current months for all organizations. | [optional] | +| **cspm_container_hwm_sum** | **Integer** | Shows the sum of the the high-water marks of Cloud Security Posture Management containers over all hours in the current months for all organizations. | [optional] | +| **cspm_host_top99p_sum** | **Integer** | Shows the 99th percentile of all Cloud Security Posture Management hosts over all hours in the current months for all organizations. | [optional] | +| **custom_ts_sum** | **Integer** | Shows the average number of distinct custom metrics over all hours in the current months for all organizations. | [optional] | +| **cws_containers_avg_sum** | **Integer** | Shows the average of all distinct Cloud Workload Security containers over all hours in the current months for all organizations. | [optional] | +| **cws_host_top99p_sum** | **Integer** | Shows the 99th percentile of all Cloud Workload Security hosts over all hours in the current months for all organizations. | [optional] | +| **dbm_host_top99p_sum** | **Integer** | Shows the 99th percentile of all Database Monitoring hosts over all hours in the current month for all organizations. | [optional] | +| **dbm_queries_avg_sum** | **Integer** | Shows the average of all distinct Database Monitoring Normalized Queries over all hours in the current month for all organizations. | [optional] | +| **end_date** | **Time** | Shows the last date of usage in the current months for all organizations. | [optional] | +| **fargate_tasks_count_avg_sum** | **Integer** | Shows the average of all Fargate tasks over all hours in the current months for all organizations. | [optional] | +| **fargate_tasks_count_hwm_sum** | **Integer** | Shows the sum of the high-water marks of all Fargate tasks over all hours in the current months for all organizations. | [optional] | +| **gcp_host_top99p_sum** | **Integer** | Shows the 99th percentile of all GCP hosts over all hours in the current months for all organizations. | [optional] | +| **heroku_host_top99p_sum** | **Integer** | Shows the 99th percentile of all Heroku dynos over all hours in the current months for all organizations. | [optional] | +| **incident_management_monthly_active_users_hwm_sum** | **Integer** | Shows sum of the the high-water marks of incident management monthly active users in the current months for all organizations. | [optional] | +| **indexed_events_count_agg_sum** | **Integer** | Shows the sum of all log events indexed over all hours in the current months for all organizations. | [optional] | +| **infra_host_top99p_sum** | **Integer** | Shows the 99th percentile of all distinct infrastructure hosts over all hours in the current months for all organizations. | [optional] | +| **ingested_events_bytes_agg_sum** | **Integer** | Shows the sum of all log bytes ingested over all hours in the current months for all organizations. | [optional] | +| **iot_device_agg_sum** | **Integer** | Shows the sum of all IoT devices over all hours in the current months for all organizations. | [optional] | +| **iot_device_top99p_sum** | **Integer** | Shows the 99th percentile of all IoT devices over all hours in the current months of all organizations. | [optional] | +| **last_updated** | **Time** | Shows the the most recent hour in the current months for all organizations for which all usages were calculated. | [optional] | +| **live_indexed_events_agg_sum** | **Integer** | Shows the sum of all live logs indexed over all hours in the current months for all organizations (data available as of December 1, 2020). | [optional] | +| **live_ingested_bytes_agg_sum** | **Integer** | Shows the sum of all live logs bytes ingested over all hours in the current months for all organizations (data available as of December 1, 2020). | [optional] | +| **logs_by_retention** | [**LogsByRetention**](LogsByRetention.md) | | [optional] | +| **mobile_rum_session_count_agg_sum** | **Integer** | Shows the sum of all mobile RUM Sessions over all hours in the current months for all organizations. | [optional] | +| **mobile_rum_session_count_android_agg_sum** | **Integer** | Shows the sum of all mobile RUM Sessions on Android over all hours in the current months for all organizations. | [optional] | +| **mobile_rum_session_count_ios_agg_sum** | **Integer** | Shows the sum of all mobile RUM Sessions on iOS over all hours in the current months for all organizations. | [optional] | +| **netflow_indexed_events_count_agg_sum** | **Integer** | Shows the sum of all Network flows indexed over all hours in the current months for all organizations. | [optional] | +| **npm_host_top99p_sum** | **Integer** | Shows the 99th percentile of all distinct Networks hosts over all hours in the current months for all organizations. | [optional] | +| **opentelemetry_host_top99p_sum** | **Integer** | Shows the 99th percentile of all hosts reported by the Datadog exporter for the OpenTelemetry Collector over all hours in the current months for all organizations. | [optional] | +| **profiling_container_agent_count_avg** | **Integer** | Shows the average number of profiled containers over all hours in the current months for all organizations. | [optional] | +| **profiling_host_count_top99p_sum** | **Integer** | Shows the 99th percentile of all profiled hosts over all hours in the current months for all organizations. | [optional] | +| **rehydrated_indexed_events_agg_sum** | **Integer** | Shows the sum of all rehydrated logs indexed over all hours in the current months for all organizations (data available as of December 1, 2020). | [optional] | +| **rehydrated_ingested_bytes_agg_sum** | **Integer** | Shows the sum of all rehydrated logs bytes ingested over all hours in the current months for all organizations (data available as of December 1, 2020). | [optional] | +| **rum_session_count_agg_sum** | **Integer** | Shows the sum of all browser RUM Sessions over all hours in the current months for all organizations. | [optional] | +| **rum_total_session_count_agg_sum** | **Integer** | Shows the sum of RUM Sessions (browser and mobile) over all hours in the current months for all organizations. | [optional] | +| **sds_logs_scanned_bytes_sum** | **Integer** | Shows the sum of all bytes scanned of logs usage by the Sensitive Data Scanner over all hours in the current month for all organizations. | [optional] | +| **sds_total_scanned_bytes_sum** | **Integer** | Shows the sum of all bytes scanned across all usage types by the Sensitive Data Scanner over all hours in the current month for all organizations. | [optional] | +| **start_date** | **Time** | Shows the first date of usage in the current months for all organizations. | [optional] | +| **synthetics_browser_check_calls_count_agg_sum** | **Integer** | Shows the sum of all Synthetic browser tests over all hours in the current months for all organizations. | [optional] | +| **synthetics_check_calls_count_agg_sum** | **Integer** | Shows the sum of all Synthetic API tests over all hours in the current months for all organizations. | [optional] | +| **trace_search_indexed_events_count_agg_sum** | **Integer** | Shows the sum of all Indexed Spans indexed over all hours in the current months for all organizations. | [optional] | +| **twol_ingested_events_bytes_agg_sum** | **Integer** | Shows the sum of all tracing without limits bytes ingested over all hours in the current months for all organizations. | [optional] | +| **usage** | [**Array<UsageSummaryDate>**](UsageSummaryDate.md) | An array of objects regarding hourly usage. | [optional] | +| **vsphere_host_top99p_sum** | **Integer** | Shows the 99th percentile of all vSphere hosts over all hours in the current months for all organizations. | [optional] | ## Example @@ -125,4 +125,3 @@ instance = DatadogAPIClient::V1::UsageSummaryResponse.new( vsphere_host_top99p_sum: null ) ``` - diff --git a/docs/v1/UsageSyntheticsAPIHour.md b/docs/v1/UsageSyntheticsAPIHour.md index 039dfbbe471e..1ae6e5d6109e 100644 --- a/docs/v1/UsageSyntheticsAPIHour.md +++ b/docs/v1/UsageSyntheticsAPIHour.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| --------------------- | ----------- | ------------------------------------------------ | ---------- | | **check_calls_count** | **Integer** | Contains the number of Synthetics API tests run. | [optional] | -| **hour** | **Time** | The hour for the usage. | [optional] | +| **hour** | **Time** | The hour for the usage. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::UsageSyntheticsAPIHour.new( hour: null ) ``` - diff --git a/docs/v1/UsageSyntheticsAPIResponse.md b/docs/v1/UsageSyntheticsAPIResponse.md index 95f3ddee6288..a6a3d1d2c3c7 100644 --- a/docs/v1/UsageSyntheticsAPIResponse.md +++ b/docs/v1/UsageSyntheticsAPIResponse.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| --------- | -------------------------------------------------------------------- | ------------------------------------------ | ---------- | | **usage** | [**Array<UsageSyntheticsAPIHour>**](UsageSyntheticsAPIHour.md) | Get hourly usage for Synthetics API tests. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::UsageSyntheticsAPIResponse.new( usage: null ) ``` - diff --git a/docs/v1/UsageSyntheticsBrowserHour.md b/docs/v1/UsageSyntheticsBrowserHour.md index 377822f2e469..f384749e2a76 100644 --- a/docs/v1/UsageSyntheticsBrowserHour.md +++ b/docs/v1/UsageSyntheticsBrowserHour.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| ----------------------------- | ----------- | ---------------------------------------------------- | ---------- | | **browser_check_calls_count** | **Integer** | Contains the number of Synthetics Browser tests run. | [optional] | -| **hour** | **Time** | The hour for the usage. | [optional] | +| **hour** | **Time** | The hour for the usage. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::UsageSyntheticsBrowserHour.new( hour: null ) ``` - diff --git a/docs/v1/UsageSyntheticsBrowserResponse.md b/docs/v1/UsageSyntheticsBrowserResponse.md index c55c95241300..9a58e2f069ff 100644 --- a/docs/v1/UsageSyntheticsBrowserResponse.md +++ b/docs/v1/UsageSyntheticsBrowserResponse.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| --------- | ---------------------------------------------------------------------------- | ---------------------------------------------- | ---------- | | **usage** | [**Array<UsageSyntheticsBrowserHour>**](UsageSyntheticsBrowserHour.md) | Get hourly usage for Synthetics Browser tests. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::UsageSyntheticsBrowserResponse.new( usage: null ) ``` - diff --git a/docs/v1/UsageSyntheticsHour.md b/docs/v1/UsageSyntheticsHour.md index 4a57f3ff821d..c71dab973953 100644 --- a/docs/v1/UsageSyntheticsHour.md +++ b/docs/v1/UsageSyntheticsHour.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| --------------------- | ----------- | ------------------------------------------------ | ---------- | | **check_calls_count** | **Integer** | Contains the number of Synthetics API tests run. | [optional] | -| **hour** | **Time** | The hour for the usage. | [optional] | +| **hour** | **Time** | The hour for the usage. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::UsageSyntheticsHour.new( hour: null ) ``` - diff --git a/docs/v1/UsageSyntheticsResponse.md b/docs/v1/UsageSyntheticsResponse.md index d1533be3ed87..5a993775fccb 100644 --- a/docs/v1/UsageSyntheticsResponse.md +++ b/docs/v1/UsageSyntheticsResponse.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| --------- | -------------------------------------------------------------- | ----------------------------------------------------------------------------- | ---------- | | **usage** | [**Array<UsageSyntheticsHour>**](UsageSyntheticsHour.md) | Array with the number of hourly Synthetics test run for a given organization. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::UsageSyntheticsResponse.new( usage: null ) ``` - diff --git a/docs/v1/UsageTimeseriesHour.md b/docs/v1/UsageTimeseriesHour.md index e8146bd97a07..e7635710434e 100644 --- a/docs/v1/UsageTimeseriesHour.md +++ b/docs/v1/UsageTimeseriesHour.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **hour** | **Time** | The hour for the usage. | [optional] | -| **num_custom_input_timeseries** | **Integer** | Contains the number of custom metrics that are inputs for aggregations (metric configured is custom). | [optional] | +| Name | Type | Description | Notes | +| -------------------------------- | ----------- | ------------------------------------------------------------------------------------------------------ | ---------- | +| **hour** | **Time** | The hour for the usage. | [optional] | +| **num_custom_input_timeseries** | **Integer** | Contains the number of custom metrics that are inputs for aggregations (metric configured is custom). | [optional] | | **num_custom_output_timeseries** | **Integer** | Contains the number of custom metrics that are outputs for aggregations (metric configured is custom). | [optional] | -| **num_custom_timeseries** | **Integer** | Contains sum of non-aggregation custom metrics and custom metrics that are outputs for aggregations. | [optional] | +| **num_custom_timeseries** | **Integer** | Contains sum of non-aggregation custom metrics and custom metrics that are outputs for aggregations. | [optional] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V1::UsageTimeseriesHour.new( num_custom_timeseries: null ) ``` - diff --git a/docs/v1/UsageTimeseriesResponse.md b/docs/v1/UsageTimeseriesResponse.md index 4d0fb2b6954c..079c39480414 100644 --- a/docs/v1/UsageTimeseriesResponse.md +++ b/docs/v1/UsageTimeseriesResponse.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| --------- | -------------------------------------------------------------- | --------------------------------------------------------- | ---------- | | **usage** | [**Array<UsageTimeseriesHour>**](UsageTimeseriesHour.md) | An array of objects regarding hourly usage of timeseries. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::UsageTimeseriesResponse.new( usage: null ) ``` - diff --git a/docs/v1/UsageTopAvgMetricsHour.md b/docs/v1/UsageTopAvgMetricsHour.md index bd3b67ab8aeb..3ede3eb93863 100644 --- a/docs/v1/UsageTopAvgMetricsHour.md +++ b/docs/v1/UsageTopAvgMetricsHour.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **avg_metric_hour** | **Integer** | Average number of timeseries per hour in which the metric occurs. | [optional] | -| **max_metric_hour** | **Integer** | Maximum number of timeseries per hour in which the metric occurs. | [optional] | -| **metric_category** | [**UsageMetricCategory**](UsageMetricCategory.md) | | [optional] | -| **metric_name** | **String** | Contains the custom metric name. | [optional] | +| Name | Type | Description | Notes | +| ------------------- | ------------------------------------------------- | ----------------------------------------------------------------- | ---------- | +| **avg_metric_hour** | **Integer** | Average number of timeseries per hour in which the metric occurs. | [optional] | +| **max_metric_hour** | **Integer** | Maximum number of timeseries per hour in which the metric occurs. | [optional] | +| **metric_category** | [**UsageMetricCategory**](UsageMetricCategory.md) | | [optional] | +| **metric_name** | **String** | Contains the custom metric name. | [optional] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V1::UsageTopAvgMetricsHour.new( metric_name: null ) ``` - diff --git a/docs/v1/UsageTopAvgMetricsMetadata.md b/docs/v1/UsageTopAvgMetricsMetadata.md index 6e97b98dfd36..267853380f54 100644 --- a/docs/v1/UsageTopAvgMetricsMetadata.md +++ b/docs/v1/UsageTopAvgMetricsMetadata.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **day** | **Time** | The day value from the user request that contains the returned usage data. (If day was used the request) | [optional] | -| **month** | **Time** | The month value from the user request that contains the returned usage data. (If month was used the request) | [optional] | -| **pagination** | [**UsageAttributionPagination**](UsageAttributionPagination.md) | | [optional] | +| Name | Type | Description | Notes | +| -------------- | --------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ | ---------- | +| **day** | **Time** | The day value from the user request that contains the returned usage data. (If day was used the request) | [optional] | +| **month** | **Time** | The month value from the user request that contains the returned usage data. (If month was used the request) | [optional] | +| **pagination** | [**UsageAttributionPagination**](UsageAttributionPagination.md) | | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::UsageTopAvgMetricsMetadata.new( pagination: null ) ``` - diff --git a/docs/v1/UsageTopAvgMetricsResponse.md b/docs/v1/UsageTopAvgMetricsResponse.md index 8f8714a09c45..630fdf589b1d 100644 --- a/docs/v1/UsageTopAvgMetricsResponse.md +++ b/docs/v1/UsageTopAvgMetricsResponse.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **metadata** | [**UsageTopAvgMetricsMetadata**](UsageTopAvgMetricsMetadata.md) | | [optional] | -| **usage** | [**Array<UsageTopAvgMetricsHour>**](UsageTopAvgMetricsHour.md) | Number of hourly recorded custom metrics for a given organization. | [optional] | +| Name | Type | Description | Notes | +| ------------ | -------------------------------------------------------------------- | ------------------------------------------------------------------ | ---------- | +| **metadata** | [**UsageTopAvgMetricsMetadata**](UsageTopAvgMetricsMetadata.md) | | [optional] | +| **usage** | [**Array<UsageTopAvgMetricsHour>**](UsageTopAvgMetricsHour.md) | Number of hourly recorded custom metrics for a given organization. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::UsageTopAvgMetricsResponse.new( usage: null ) ``` - diff --git a/docs/v1/User.md b/docs/v1/User.md index 274376f2982a..4d57cf32b263 100644 --- a/docs/v1/User.md +++ b/docs/v1/User.md @@ -2,15 +2,15 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **access_role** | [**AccessRole**](AccessRole.md) | | [optional][default to 'st'] | -| **disabled** | **Boolean** | The new disabled status of the user. | [optional] | -| **email** | **String** | The new email of the user. | [optional] | -| **handle** | **String** | The user handle, must be a valid email. | [optional] | -| **icon** | **String** | Gravatar icon associated to the user. | [optional][readonly] | -| **name** | **String** | The name of the user. | [optional] | -| **verified** | **Boolean** | Whether or not the user logged in Datadog at least once. | [optional][readonly] | +| Name | Type | Description | Notes | +| --------------- | ------------------------------- | -------------------------------------------------------- | ----------------------------------- | +| **access_role** | [**AccessRole**](AccessRole.md) | | [optional][default to 'st'] | +| **disabled** | **Boolean** | The new disabled status of the user. | [optional] | +| **email** | **String** | The new email of the user. | [optional] | +| **handle** | **String** | The user handle, must be a valid email. | [optional] | +| **icon** | **String** | Gravatar icon associated to the user. | [optional][readonly] | +| **name** | **String** | The name of the user. | [optional] | +| **verified** | **Boolean** | Whether or not the user logged in Datadog at least once. | [optional][readonly] | ## Example @@ -27,4 +27,3 @@ instance = DatadogAPIClient::V1::User.new( verified: true ) ``` - diff --git a/docs/v1/UserDisableResponse.md b/docs/v1/UserDisableResponse.md index e2e3c5bbbc93..c044ddeaa61f 100644 --- a/docs/v1/UserDisableResponse.md +++ b/docs/v1/UserDisableResponse.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| ----------- | ---------- | ------------------------------------------------------------------- | ---------- | | **message** | **String** | Information pertaining to a user disabled for a given organization. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::UserDisableResponse.new( message: null ) ``` - diff --git a/docs/v1/UserListResponse.md b/docs/v1/UserListResponse.md index 3f3eebea789c..4c04421a6766 100644 --- a/docs/v1/UserListResponse.md +++ b/docs/v1/UserListResponse.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| --------- | -------------------------------- | --------------- | ---------- | | **users** | [**Array<User>**](User.md) | Array of users. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::UserListResponse.new( users: null ) ``` - diff --git a/docs/v1/UserResponse.md b/docs/v1/UserResponse.md index 8a298acda334..cbad5a45d2a7 100644 --- a/docs/v1/UserResponse.md +++ b/docs/v1/UserResponse.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **user** | [**User**](User.md) | | [optional] | +| Name | Type | Description | Notes | +| -------- | ------------------- | ----------- | ---------- | +| **user** | [**User**](User.md) | | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::UserResponse.new( user: null ) ``` - diff --git a/docs/v1/UsersAPI.md b/docs/v1/UsersAPI.md index 09b0af799e0d..85e8f5bb08f5 100644 --- a/docs/v1/UsersAPI.md +++ b/docs/v1/UsersAPI.md @@ -2,14 +2,13 @@ All URIs are relative to *https://api.datadoghq.com* -| Method | HTTP request | Description | -| ------ | ------------ | ----------- | -| [**create_user**](UsersAPI.md#create_user) | **POST** /api/v1/user | Create a user | -| [**disable_user**](UsersAPI.md#disable_user) | **DELETE** /api/v1/user/{user_handle} | Disable a user | -| [**get_user**](UsersAPI.md#get_user) | **GET** /api/v1/user/{user_handle} | Get user details | -| [**list_users**](UsersAPI.md#list_users) | **GET** /api/v1/user | List all users | -| [**update_user**](UsersAPI.md#update_user) | **PUT** /api/v1/user/{user_handle} | Update a user | - +| Method | HTTP request | Description | +| -------------------------------------------- | ------------------------------------- | ---------------- | +| [**create_user**](UsersAPI.md#create_user) | **POST** /api/v1/user | Create a user | +| [**disable_user**](UsersAPI.md#disable_user) | **DELETE** /api/v1/user/{user_handle} | Disable a user | +| [**get_user**](UsersAPI.md#get_user) | **GET** /api/v1/user/{user_handle} | Get user details | +| [**list_users**](UsersAPI.md#list_users) | **GET** /api/v1/user | List all users | +| [**update_user**](UsersAPI.md#update_user) | **PUT** /api/v1/user/{user_handle} | Update a user | ## create_user @@ -56,9 +55,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**User**](User.md) | User object that needs to be created. | | +| Name | Type | Description | Notes | +| -------- | ------------------- | ------------------------------------- | ----- | +| **body** | [**User**](User.md) | User object that needs to be created. | | ### Return type @@ -73,7 +72,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## disable_user > disable_user(user_handle) @@ -119,9 +117,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **user_handle** | **String** | The handle of the user. | | +| Name | Type | Description | Notes | +| --------------- | ---------- | ----------------------- | ----- | +| **user_handle** | **String** | The handle of the user. | | ### Return type @@ -136,7 +134,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## get_user > get_user(user_handle) @@ -179,9 +176,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **user_handle** | **String** | The ID of the user. | | +| Name | Type | Description | Notes | +| --------------- | ---------- | ------------------- | ----- | +| **user_handle** | **String** | The ID of the user. | | ### Return type @@ -196,7 +193,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## list_users > list_users @@ -253,7 +249,6 @@ This endpoint does not need any parameter. - **Content-Type**: Not defined - **Accept**: application/json - ## update_user > update_user(user_handle, body) @@ -299,10 +294,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **user_handle** | **String** | The ID of the user. | | -| **body** | [**User**](User.md) | Description of the update. | | +| Name | Type | Description | Notes | +| --------------- | ------------------- | -------------------------- | ----- | +| **user_handle** | **String** | The ID of the user. | | +| **body** | [**User**](User.md) | Description of the update. | | ### Return type @@ -316,4 +311,3 @@ end - **Content-Type**: application/json - **Accept**: application/json - diff --git a/docs/v1/WebhooksIntegration.md b/docs/v1/WebhooksIntegration.md index c75de32c001b..344c5a8ae7a4 100644 --- a/docs/v1/WebhooksIntegration.md +++ b/docs/v1/WebhooksIntegration.md @@ -2,13 +2,13 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **custom_headers** | **String** | If `null`, uses no header. If given a JSON payload, these will be headers attached to your webhook. | [optional] | -| **encode_as** | [**WebhooksIntegrationEncoding**](WebhooksIntegrationEncoding.md) | | [optional][default to 'json'] | -| **name** | **String** | The name of the webhook. It corresponds with `<WEBHOOK_NAME>`. Learn more on how to use it in [monitor notifications](https://docs.datadoghq.com/monitors/notify). | | -| **payload** | **String** | If `null`, uses the default payload. If given a JSON payload, the webhook returns the payload specified by the given payload. [Webhooks variable usage](https://docs.datadoghq.com/integrations/webhooks/#usage). | [optional] | -| **url** | **String** | URL of the webhook. | | +| Name | Type | Description | Notes | +| ------------------ | ----------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | +| **custom_headers** | **String** | If `null`, uses no header. If given a JSON payload, these will be headers attached to your webhook. | [optional] | +| **encode_as** | [**WebhooksIntegrationEncoding**](WebhooksIntegrationEncoding.md) | | [optional][default to 'json'] | +| **name** | **String** | The name of the webhook. It corresponds with `<WEBHOOK_NAME>`. Learn more on how to use it in [monitor notifications](https://docs.datadoghq.com/monitors/notify). | | +| **payload** | **String** | If `null`, uses the default payload. If given a JSON payload, the webhook returns the payload specified by the given payload. [Webhooks variable usage](https://docs.datadoghq.com/integrations/webhooks/#usage). | [optional] | +| **url** | **String** | URL of the webhook. | | ## Example @@ -23,4 +23,3 @@ instance = DatadogAPIClient::V1::WebhooksIntegration.new( url: https://example.com/webhook ) ``` - diff --git a/docs/v1/WebhooksIntegrationAPI.md b/docs/v1/WebhooksIntegrationAPI.md index 3df8d53db409..b2c294442fd1 100644 --- a/docs/v1/WebhooksIntegrationAPI.md +++ b/docs/v1/WebhooksIntegrationAPI.md @@ -2,17 +2,16 @@ All URIs are relative to *https://api.datadoghq.com* -| Method | HTTP request | Description | -| ------ | ------------ | ----------- | -| [**create_webhooks_integration**](WebhooksIntegrationAPI.md#create_webhooks_integration) | **POST** /api/v1/integration/webhooks/configuration/webhooks | Create a webhooks integration | -| [**create_webhooks_integration_custom_variable**](WebhooksIntegrationAPI.md#create_webhooks_integration_custom_variable) | **POST** /api/v1/integration/webhooks/configuration/custom-variables | Create a custom variable | -| [**delete_webhooks_integration**](WebhooksIntegrationAPI.md#delete_webhooks_integration) | **DELETE** /api/v1/integration/webhooks/configuration/webhooks/{webhook_name} | Delete a webhook | -| [**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 | -| [**get_webhooks_integration**](WebhooksIntegrationAPI.md#get_webhooks_integration) | **GET** /api/v1/integration/webhooks/configuration/webhooks/{webhook_name} | Get a webhook integration | -| [**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 | -| [**update_webhooks_integration**](WebhooksIntegrationAPI.md#update_webhooks_integration) | **PUT** /api/v1/integration/webhooks/configuration/webhooks/{webhook_name} | Update a webhook | -| [**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 | - +| Method | HTTP request | Description | +| ------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------- | ----------------------------- | +| [**create_webhooks_integration**](WebhooksIntegrationAPI.md#create_webhooks_integration) | **POST** /api/v1/integration/webhooks/configuration/webhooks | Create a webhooks integration | +| [**create_webhooks_integration_custom_variable**](WebhooksIntegrationAPI.md#create_webhooks_integration_custom_variable) | **POST** /api/v1/integration/webhooks/configuration/custom-variables | Create a custom variable | +| [**delete_webhooks_integration**](WebhooksIntegrationAPI.md#delete_webhooks_integration) | **DELETE** /api/v1/integration/webhooks/configuration/webhooks/{webhook_name} | Delete a webhook | +| [**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 | +| [**get_webhooks_integration**](WebhooksIntegrationAPI.md#get_webhooks_integration) | **GET** /api/v1/integration/webhooks/configuration/webhooks/{webhook_name} | Get a webhook integration | +| [**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 | +| [**update_webhooks_integration**](WebhooksIntegrationAPI.md#update_webhooks_integration) | **PUT** /api/v1/integration/webhooks/configuration/webhooks/{webhook_name} | Update a webhook | +| [**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 | ## create_webhooks_integration @@ -56,9 +55,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**WebhooksIntegration**](WebhooksIntegration.md) | Create a webhooks integration request body. | | +| Name | Type | Description | Notes | +| -------- | ------------------------------------------------- | ------------------------------------------- | ----- | +| **body** | [**WebhooksIntegration**](WebhooksIntegration.md) | Create a webhooks integration request body. | | ### Return type @@ -73,7 +72,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## create_webhooks_integration_custom_variable > create_webhooks_integration_custom_variable(body) @@ -116,9 +114,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**WebhooksIntegrationCustomVariable**](WebhooksIntegrationCustomVariable.md) | Define a custom variable request body. | | +| Name | Type | Description | Notes | +| -------- | ----------------------------------------------------------------------------- | -------------------------------------- | ----- | +| **body** | [**WebhooksIntegrationCustomVariable**](WebhooksIntegrationCustomVariable.md) | Define a custom variable request body. | | ### Return type @@ -133,7 +131,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## delete_webhooks_integration > delete_webhooks_integration(webhook_name) @@ -175,9 +172,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **webhook_name** | **String** | The name of the webhook. | | +| Name | Type | Description | Notes | +| ---------------- | ---------- | ------------------------ | ----- | +| **webhook_name** | **String** | The name of the webhook. | | ### Return type @@ -192,7 +189,6 @@ nil (empty response body) - **Content-Type**: Not defined - **Accept**: application/json - ## delete_webhooks_integration_custom_variable > delete_webhooks_integration_custom_variable(custom_variable_name) @@ -234,9 +230,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **custom_variable_name** | **String** | The name of the custom variable. | | +| Name | Type | Description | Notes | +| ------------------------ | ---------- | -------------------------------- | ----- | +| **custom_variable_name** | **String** | The name of the custom variable. | | ### Return type @@ -251,7 +247,6 @@ nil (empty response body) - **Content-Type**: Not defined - **Accept**: application/json - ## get_webhooks_integration > get_webhooks_integration(webhook_name) @@ -294,9 +289,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **webhook_name** | **String** | The name of the webhook. | | +| Name | Type | Description | Notes | +| ---------------- | ---------- | ------------------------ | ----- | +| **webhook_name** | **String** | The name of the webhook. | | ### Return type @@ -311,7 +306,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## get_webhooks_integration_custom_variable > get_webhooks_integration_custom_variable(custom_variable_name) @@ -357,9 +351,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **custom_variable_name** | **String** | The name of the custom variable. | | +| Name | Type | Description | Notes | +| ------------------------ | ---------- | -------------------------------- | ----- | +| **custom_variable_name** | **String** | The name of the custom variable. | | ### Return type @@ -374,7 +368,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## update_webhooks_integration > update_webhooks_integration(webhook_name, body) @@ -418,10 +411,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **webhook_name** | **String** | The name of the webhook. | | -| **body** | [**WebhooksIntegrationUpdateRequest**](WebhooksIntegrationUpdateRequest.md) | Update an existing Datadog-Webhooks integration. | | +| Name | Type | Description | Notes | +| ---------------- | --------------------------------------------------------------------------- | ------------------------------------------------ | ----- | +| **webhook_name** | **String** | The name of the webhook. | | +| **body** | [**WebhooksIntegrationUpdateRequest**](WebhooksIntegrationUpdateRequest.md) | Update an existing Datadog-Webhooks integration. | | ### Return type @@ -436,7 +429,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## update_webhooks_integration_custom_variable > update_webhooks_integration_custom_variable(custom_variable_name, body) @@ -480,10 +472,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **custom_variable_name** | **String** | The name of the custom variable. | | -| **body** | [**WebhooksIntegrationCustomVariableUpdateRequest**](WebhooksIntegrationCustomVariableUpdateRequest.md) | Update an existing custom variable request body. | | +| Name | Type | Description | Notes | +| ------------------------ | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------ | ----- | +| **custom_variable_name** | **String** | The name of the custom variable. | | +| **body** | [**WebhooksIntegrationCustomVariableUpdateRequest**](WebhooksIntegrationCustomVariableUpdateRequest.md) | Update an existing custom variable request body. | | ### Return type @@ -497,4 +489,3 @@ end - **Content-Type**: application/json - **Accept**: application/json - diff --git a/docs/v1/WebhooksIntegrationCustomVariable.md b/docs/v1/WebhooksIntegrationCustomVariable.md index 945ac00b7c9e..6100594747e4 100644 --- a/docs/v1/WebhooksIntegrationCustomVariable.md +++ b/docs/v1/WebhooksIntegrationCustomVariable.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **is_secret** | **Boolean** | Make custom variable is secret or not. If the custom variable is secret, the value is not returned in the response payload. | | -| **name** | **String** | The name of the variable. It corresponds with `<CUSTOM_VARIABLE_NAME>`. | | -| **value** | **String** | Value of the custom variable. | | +| Name | Type | Description | Notes | +| ------------- | ----------- | --------------------------------------------------------------------------------------------------------------------------- | ----- | +| **is_secret** | **Boolean** | Make custom variable is secret or not. If the custom variable is secret, the value is not returned in the response payload. | | +| **name** | **String** | The name of the variable. It corresponds with `<CUSTOM_VARIABLE_NAME>`. | | +| **value** | **String** | Value of the custom variable. | | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::WebhooksIntegrationCustomVariable.new( value: CUSTOM_VARIABLE_VALUE ) ``` - diff --git a/docs/v1/WebhooksIntegrationCustomVariableResponse.md b/docs/v1/WebhooksIntegrationCustomVariableResponse.md index e380ef7b6d35..3231f82dc2dd 100644 --- a/docs/v1/WebhooksIntegrationCustomVariableResponse.md +++ b/docs/v1/WebhooksIntegrationCustomVariableResponse.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **is_secret** | **Boolean** | Make custom variable is secret or not. If the custom variable is secret, the value is not returned in the response payload. | | -| **name** | **String** | The name of the variable. It corresponds with `<CUSTOM_VARIABLE_NAME>`. It must only contains upper-case characters, integers or underscores. | | -| **value** | **String** | Value of the custom variable. It won't be returned if the variable is secret. | [optional] | +| Name | Type | Description | Notes | +| ------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **is_secret** | **Boolean** | Make custom variable is secret or not. If the custom variable is secret, the value is not returned in the response payload. | | +| **name** | **String** | The name of the variable. It corresponds with `<CUSTOM_VARIABLE_NAME>`. It must only contains upper-case characters, integers or underscores. | | +| **value** | **String** | Value of the custom variable. It won't be returned if the variable is secret. | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::WebhooksIntegrationCustomVariableResponse.new( value: CUSTOM_VARIABLE_VALUE ) ``` - diff --git a/docs/v1/WebhooksIntegrationCustomVariableUpdateRequest.md b/docs/v1/WebhooksIntegrationCustomVariableUpdateRequest.md index 9cf7487f28fa..8ef6b74f6c9c 100644 --- a/docs/v1/WebhooksIntegrationCustomVariableUpdateRequest.md +++ b/docs/v1/WebhooksIntegrationCustomVariableUpdateRequest.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **is_secret** | **Boolean** | Make custom variable is secret or not. If the custom variable is secret, the value is not returned in the response payload. | [optional] | -| **name** | **String** | The name of the variable. It corresponds with `<CUSTOM_VARIABLE_NAME>`. It must only contains upper-case characters, integers or underscores. | [optional] | -| **value** | **String** | Value of the custom variable. | [optional] | +| Name | Type | Description | Notes | +| ------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **is_secret** | **Boolean** | Make custom variable is secret or not. If the custom variable is secret, the value is not returned in the response payload. | [optional] | +| **name** | **String** | The name of the variable. It corresponds with `<CUSTOM_VARIABLE_NAME>`. It must only contains upper-case characters, integers or underscores. | [optional] | +| **value** | **String** | Value of the custom variable. | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::WebhooksIntegrationCustomVariableUpdateRequest. value: CUSTOM_VARIABLE_VALUE ) ``` - diff --git a/docs/v1/WebhooksIntegrationEncoding.md b/docs/v1/WebhooksIntegrationEncoding.md index ade6ed10fe84..5cf719ad8a47 100644 --- a/docs/v1/WebhooksIntegrationEncoding.md +++ b/docs/v1/WebhooksIntegrationEncoding.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::WebhooksIntegrationEncoding.new() ``` - diff --git a/docs/v1/WebhooksIntegrationUpdateRequest.md b/docs/v1/WebhooksIntegrationUpdateRequest.md index 0b8e17d57c79..8590b93cde3b 100644 --- a/docs/v1/WebhooksIntegrationUpdateRequest.md +++ b/docs/v1/WebhooksIntegrationUpdateRequest.md @@ -2,13 +2,13 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **custom_headers** | **String** | If `null`, uses no header. If given a JSON payload, these will be headers attached to your webhook. | [optional] | -| **encode_as** | [**WebhooksIntegrationEncoding**](WebhooksIntegrationEncoding.md) | | [optional][default to 'json'] | -| **name** | **String** | The name of the webhook. It corresponds with `<WEBHOOK_NAME>`. Learn more on how to use it in [monitor notifications](https://docs.datadoghq.com/monitors/notify). | [optional] | -| **payload** | **String** | If `null`, uses the default payload. If given a JSON payload, the webhook returns the payload specified by the given payload. [Webhooks variable usage](https://docs.datadoghq.com/integrations/webhooks/#usage). | [optional] | -| **url** | **String** | URL of the webhook. | [optional] | +| Name | Type | Description | Notes | +| ------------------ | ----------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | +| **custom_headers** | **String** | If `null`, uses no header. If given a JSON payload, these will be headers attached to your webhook. | [optional] | +| **encode_as** | [**WebhooksIntegrationEncoding**](WebhooksIntegrationEncoding.md) | | [optional][default to 'json'] | +| **name** | **String** | The name of the webhook. It corresponds with `<WEBHOOK_NAME>`. Learn more on how to use it in [monitor notifications](https://docs.datadoghq.com/monitors/notify). | [optional] | +| **payload** | **String** | If `null`, uses the default payload. If given a JSON payload, the webhook returns the payload specified by the given payload. [Webhooks variable usage](https://docs.datadoghq.com/integrations/webhooks/#usage). | [optional] | +| **url** | **String** | URL of the webhook. | [optional] | ## Example @@ -23,4 +23,3 @@ instance = DatadogAPIClient::V1::WebhooksIntegrationUpdateRequest.new( url: https://example.com/webhook ) ``` - diff --git a/docs/v1/Widget.md b/docs/v1/Widget.md index 3e23f810123f..7213e5b5620f 100644 --- a/docs/v1/Widget.md +++ b/docs/v1/Widget.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **definition** | [**WidgetDefinition**](WidgetDefinition.md) | | | -| **id** | **Integer** | ID of the widget. | [optional] | -| **layout** | [**WidgetLayout**](WidgetLayout.md) | | [optional] | +| Name | Type | Description | Notes | +| -------------- | ------------------------------------------- | ----------------- | ---------- | +| **definition** | [**WidgetDefinition**](WidgetDefinition.md) | | | +| **id** | **Integer** | ID of the widget. | [optional] | +| **layout** | [**WidgetLayout**](WidgetLayout.md) | | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::Widget.new( layout: null ) ``` - diff --git a/docs/v1/WidgetAggregator.md b/docs/v1/WidgetAggregator.md index 74dd5f223f6f..022b76a607b9 100644 --- a/docs/v1/WidgetAggregator.md +++ b/docs/v1/WidgetAggregator.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::WidgetAggregator.new() ``` - diff --git a/docs/v1/WidgetAxis.md b/docs/v1/WidgetAxis.md index c70400d628c4..4ec222b09221 100644 --- a/docs/v1/WidgetAxis.md +++ b/docs/v1/WidgetAxis.md @@ -2,13 +2,13 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **include_zero** | **Boolean** | True includes zero. | [optional] | -| **label** | **String** | The label of the axis to display on the graph. | [optional] | -| **max** | **String** | Specifies the maximum value to show on the y-axis. It takes a number, or auto for default behavior. | [optional][default to 'auto'] | -| **min** | **String** | Specifies minimum value to show on the y-axis. It takes a number, or auto for default behavior. | [optional][default to 'auto'] | -| **scale** | **String** | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, `pow##` (e.g. `pow2`, `pow0.5` etc.). | [optional][default to 'linear'] | +| Name | Type | Description | Notes | +| ---------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------- | +| **include_zero** | **Boolean** | True includes zero. | [optional] | +| **label** | **String** | The label of the axis to display on the graph. | [optional] | +| **max** | **String** | Specifies the maximum value to show on the y-axis. It takes a number, or auto for default behavior. | [optional][default to 'auto'] | +| **min** | **String** | Specifies minimum value to show on the y-axis. It takes a number, or auto for default behavior. | [optional][default to 'auto'] | +| **scale** | **String** | Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, `pow##` (e.g. `pow2`, `pow0.5` etc.). | [optional][default to 'linear'] | ## Example @@ -23,4 +23,3 @@ instance = DatadogAPIClient::V1::WidgetAxis.new( scale: null ) ``` - diff --git a/docs/v1/WidgetChangeType.md b/docs/v1/WidgetChangeType.md index b6b6a18b45df..2b71a92b1ae0 100644 --- a/docs/v1/WidgetChangeType.md +++ b/docs/v1/WidgetChangeType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::WidgetChangeType.new() ``` - diff --git a/docs/v1/WidgetColorPreference.md b/docs/v1/WidgetColorPreference.md index 15d874290658..990a705df303 100644 --- a/docs/v1/WidgetColorPreference.md +++ b/docs/v1/WidgetColorPreference.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::WidgetColorPreference.new() ``` - diff --git a/docs/v1/WidgetComparator.md b/docs/v1/WidgetComparator.md index 3450fab3f09b..d10d4d84be88 100644 --- a/docs/v1/WidgetComparator.md +++ b/docs/v1/WidgetComparator.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::WidgetComparator.new() ``` - diff --git a/docs/v1/WidgetCompareTo.md b/docs/v1/WidgetCompareTo.md index b03361a9f3e0..53d037447d93 100644 --- a/docs/v1/WidgetCompareTo.md +++ b/docs/v1/WidgetCompareTo.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::WidgetCompareTo.new() ``` - diff --git a/docs/v1/WidgetConditionalFormat.md b/docs/v1/WidgetConditionalFormat.md index 733ec2c26775..6e29479cfed1 100644 --- a/docs/v1/WidgetConditionalFormat.md +++ b/docs/v1/WidgetConditionalFormat.md @@ -2,17 +2,17 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **comparator** | [**WidgetComparator**](WidgetComparator.md) | | | -| **custom_bg_color** | **String** | Color palette to apply to the background, same values available as palette. | [optional] | -| **custom_fg_color** | **String** | Color palette to apply to the foreground, same values available as palette. | [optional] | -| **hide_value** | **Boolean** | True hides values. | [optional] | -| **image_url** | **String** | Displays an image as the background. | [optional] | -| **metric** | **String** | Metric from the request to correlate this conditional format with. | [optional] | -| **palette** | [**WidgetPalette**](WidgetPalette.md) | | | -| **timeframe** | **String** | Defines the displayed timeframe. | [optional] | -| **value** | **Float** | Value for the comparator. | | +| Name | Type | Description | Notes | +| ------------------- | ------------------------------------------- | --------------------------------------------------------------------------- | ---------- | +| **comparator** | [**WidgetComparator**](WidgetComparator.md) | | | +| **custom_bg_color** | **String** | Color palette to apply to the background, same values available as palette. | [optional] | +| **custom_fg_color** | **String** | Color palette to apply to the foreground, same values available as palette. | [optional] | +| **hide_value** | **Boolean** | True hides values. | [optional] | +| **image_url** | **String** | Displays an image as the background. | [optional] | +| **metric** | **String** | Metric from the request to correlate this conditional format with. | [optional] | +| **palette** | [**WidgetPalette**](WidgetPalette.md) | | | +| **timeframe** | **String** | Defines the displayed timeframe. | [optional] | +| **value** | **Float** | Value for the comparator. | | ## Example @@ -31,4 +31,3 @@ instance = DatadogAPIClient::V1::WidgetConditionalFormat.new( value: 0.0 ) ``` - diff --git a/docs/v1/WidgetCustomLink.md b/docs/v1/WidgetCustomLink.md index 62b038e2303d..9ac4ff39fa64 100644 --- a/docs/v1/WidgetCustomLink.md +++ b/docs/v1/WidgetCustomLink.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **is_hidden** | **Boolean** | The flag for toggling context menu link visibility. | [optional] | -| **label** | **String** | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | [optional] | -| **link** | **String** | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | [optional] | -| **override_label** | **String** | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | [optional] | +| Name | Type | Description | Notes | +| ------------------ | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **is_hidden** | **Boolean** | The flag for toggling context menu link visibility. | [optional] | +| **label** | **String** | The label for the custom link URL. Keep the label short and descriptive. Use metrics and tags as variables. | [optional] | +| **link** | **String** | The URL of the custom link. URL must include `http` or `https`. A relative URL must start with `/`. | [optional] | +| **override_label** | **String** | The label ID that refers to a context menu link. Can be `logs`, `hosts`, `traces`, `profiles`, `processes`, `containers`, or `rum`. | [optional] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V1::WidgetCustomLink.new( override_label: logs ) ``` - diff --git a/docs/v1/WidgetDefinition.md b/docs/v1/WidgetDefinition.md index 26aa6f6848bb..54e414951468 100644 --- a/docs/v1/WidgetDefinition.md +++ b/docs/v1/WidgetDefinition.md @@ -63,8 +63,8 @@ DatadogAPIClient::V1::WidgetDefinition.build(data_that_doesnt_match) #### Parameters -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| -------- | --------- | -------------------------------------------------- | | **data** | **Mixed** | data to be matched against the list of oneOf items | #### Return type @@ -98,4 +98,3 @@ DatadogAPIClient::V1::WidgetDefinition.build(data_that_doesnt_match) - `ToplistWidgetDefinition` - `TreeMapWidgetDefinition` - `nil` (if no type matches) - diff --git a/docs/v1/WidgetDisplayType.md b/docs/v1/WidgetDisplayType.md index 0d21d7a271e0..ab2acf5a0f8e 100644 --- a/docs/v1/WidgetDisplayType.md +++ b/docs/v1/WidgetDisplayType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::WidgetDisplayType.new() ``` - diff --git a/docs/v1/WidgetEvent.md b/docs/v1/WidgetEvent.md index 2e374bb874ed..e2496799fd87 100644 --- a/docs/v1/WidgetEvent.md +++ b/docs/v1/WidgetEvent.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **q** | **String** | Query definition. | | +| Name | Type | Description | Notes | +| ------------------ | ---------- | --------------------------------------------- | ---------- | +| **q** | **String** | Query definition. | | | **tags_execution** | **String** | The execution method for multi-value filters. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::WidgetEvent.new( tags_execution: null ) ``` - diff --git a/docs/v1/WidgetEventSize.md b/docs/v1/WidgetEventSize.md index e1822e34de17..7ef1f4b2e2e1 100644 --- a/docs/v1/WidgetEventSize.md +++ b/docs/v1/WidgetEventSize.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::WidgetEventSize.new() ``` - diff --git a/docs/v1/WidgetFieldSort.md b/docs/v1/WidgetFieldSort.md index 64407eb5a13d..c6bc198c3307 100644 --- a/docs/v1/WidgetFieldSort.md +++ b/docs/v1/WidgetFieldSort.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **column** | **String** | Facet path for the column | | -| **order** | [**WidgetSort**](WidgetSort.md) | | | +| Name | Type | Description | Notes | +| ---------- | ------------------------------- | ------------------------- | ----- | +| **column** | **String** | Facet path for the column | | +| **order** | [**WidgetSort**](WidgetSort.md) | | | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::WidgetFieldSort.new( order: null ) ``` - diff --git a/docs/v1/WidgetFormula.md b/docs/v1/WidgetFormula.md index df05c045934d..332c5890d8e5 100644 --- a/docs/v1/WidgetFormula.md +++ b/docs/v1/WidgetFormula.md @@ -2,13 +2,13 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **_alias** | **String** | Expression alias. | [optional] | -| **cell_display_mode** | [**TableWidgetCellDisplayMode**](TableWidgetCellDisplayMode.md) | | [optional] | -| **conditional_formats** | [**Array<WidgetConditionalFormat>**](WidgetConditionalFormat.md) | List of conditional formats. | [optional] | -| **formula** | **String** | String expression built from queries, formulas, and functions. | | -| **limit** | [**WidgetFormulaLimit**](WidgetFormulaLimit.md) | | [optional] | +| Name | Type | Description | Notes | +| ----------------------- | ---------------------------------------------------------------------- | -------------------------------------------------------------- | ---------- | +| **\_alias** | **String** | Expression alias. | [optional] | +| **cell_display_mode** | [**TableWidgetCellDisplayMode**](TableWidgetCellDisplayMode.md) | | [optional] | +| **conditional_formats** | [**Array<WidgetConditionalFormat>**](WidgetConditionalFormat.md) | List of conditional formats. | [optional] | +| **formula** | **String** | String expression built from queries, formulas, and functions. | | +| **limit** | [**WidgetFormulaLimit**](WidgetFormulaLimit.md) | | [optional] | ## Example @@ -23,4 +23,3 @@ instance = DatadogAPIClient::V1::WidgetFormula.new( limit: null ) ``` - diff --git a/docs/v1/WidgetFormulaLimit.md b/docs/v1/WidgetFormulaLimit.md index 9bf4fcd54864..67e1f05cc8b7 100644 --- a/docs/v1/WidgetFormulaLimit.md +++ b/docs/v1/WidgetFormulaLimit.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **count** | **Integer** | Number of results to return. | [optional] | -| **order** | [**QuerySortOrder**](QuerySortOrder.md) | | [optional][default to 'desc'] | +| Name | Type | Description | Notes | +| --------- | --------------------------------------- | ---------------------------- | ------------------------------------- | +| **count** | **Integer** | Number of results to return. | [optional] | +| **order** | [**QuerySortOrder**](QuerySortOrder.md) | | [optional][default to 'desc'] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::WidgetFormulaLimit.new( order: null ) ``` - diff --git a/docs/v1/WidgetGrouping.md b/docs/v1/WidgetGrouping.md index 32b55944a007..96b718d2c009 100644 --- a/docs/v1/WidgetGrouping.md +++ b/docs/v1/WidgetGrouping.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::WidgetGrouping.new() ``` - diff --git a/docs/v1/WidgetHorizontalAlign.md b/docs/v1/WidgetHorizontalAlign.md index ba50a0744411..5739e783ff0c 100644 --- a/docs/v1/WidgetHorizontalAlign.md +++ b/docs/v1/WidgetHorizontalAlign.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::WidgetHorizontalAlign.new() ``` - diff --git a/docs/v1/WidgetImageSizing.md b/docs/v1/WidgetImageSizing.md index f5d1a072a90d..597f9c575321 100644 --- a/docs/v1/WidgetImageSizing.md +++ b/docs/v1/WidgetImageSizing.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::WidgetImageSizing.new() ``` - diff --git a/docs/v1/WidgetLayout.md b/docs/v1/WidgetLayout.md index d9968abba657..32fd2a21e59d 100644 --- a/docs/v1/WidgetLayout.md +++ b/docs/v1/WidgetLayout.md @@ -2,13 +2,13 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **height** | **Integer** | The height of the widget. Should be a non-negative integer. | | +| Name | Type | Description | Notes | +| ------------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **height** | **Integer** | The height of the widget. Should be a non-negative integer. | | | **is_column_break** | **Boolean** | Whether the widget should be the first one on the second column in high density or not. **Note**: Only for the **new dashboard layout** and only one widget in the dashboard should have this property set to `true`. | [optional] | -| **width** | **Integer** | The width of the widget. Should be a non-negative integer. | | -| **x** | **Integer** | The position of the widget on the x (horizontal) axis. Should be a non-negative integer. | | -| **y** | **Integer** | The position of the widget on the y (vertical) axis. Should be a non-negative integer. | | +| **width** | **Integer** | The width of the widget. Should be a non-negative integer. | | +| **x** | **Integer** | The position of the widget on the x (horizontal) axis. Should be a non-negative integer. | | +| **y** | **Integer** | The position of the widget on the y (vertical) axis. Should be a non-negative integer. | | ## Example @@ -23,4 +23,3 @@ instance = DatadogAPIClient::V1::WidgetLayout.new( y: 0 ) ``` - diff --git a/docs/v1/WidgetLayoutType.md b/docs/v1/WidgetLayoutType.md index 573adbe59cb0..dced18ca2bcd 100644 --- a/docs/v1/WidgetLayoutType.md +++ b/docs/v1/WidgetLayoutType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::WidgetLayoutType.new() ``` - diff --git a/docs/v1/WidgetLineType.md b/docs/v1/WidgetLineType.md index 0ca25ac6e161..e263f91bc293 100644 --- a/docs/v1/WidgetLineType.md +++ b/docs/v1/WidgetLineType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::WidgetLineType.new() ``` - diff --git a/docs/v1/WidgetLineWidth.md b/docs/v1/WidgetLineWidth.md index 7848ca94b709..621c513b1279 100644 --- a/docs/v1/WidgetLineWidth.md +++ b/docs/v1/WidgetLineWidth.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::WidgetLineWidth.new() ``` - diff --git a/docs/v1/WidgetLiveSpan.md b/docs/v1/WidgetLiveSpan.md index 8b12b5db85f5..7a8d2cd84282 100644 --- a/docs/v1/WidgetLiveSpan.md +++ b/docs/v1/WidgetLiveSpan.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::WidgetLiveSpan.new() ``` - diff --git a/docs/v1/WidgetMargin.md b/docs/v1/WidgetMargin.md index 9d9ab0cb7d36..7c218b2e478d 100644 --- a/docs/v1/WidgetMargin.md +++ b/docs/v1/WidgetMargin.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::WidgetMargin.new() ``` - diff --git a/docs/v1/WidgetMarker.md b/docs/v1/WidgetMarker.md index 74208f1cb8a2..800b28a309f7 100644 --- a/docs/v1/WidgetMarker.md +++ b/docs/v1/WidgetMarker.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **display_type** | **String** | Combination of: - A severity error, warning, ok, or info - A line type: dashed, solid, or bold In this case of a Distribution widget, this can be set to be `x_axis_percentile`. | [optional] | -| **label** | **String** | Label to display over the marker. | [optional] | -| **time** | **String** | Timestamp for the widget. | [optional] | -| **value** | **String** | Value to apply. Can be a single value y = 15 or a range of values 0 < y < 10. | | +| Name | Type | Description | Notes | +| ---------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------- | +| **display_type** | **String** | Combination of: - A severity error, warning, ok, or info - A line type: dashed, solid, or bold In this case of a Distribution widget, this can be set to be `x_axis_percentile`. | [optional] | +| **label** | **String** | Label to display over the marker. | [optional] | +| **time** | **String** | Timestamp for the widget. | [optional] | +| **value** | **String** | Value to apply. Can be a single value y = 15 or a range of values 0 < y < 10. | | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V1::WidgetMarker.new( value: y = 15 ) ``` - diff --git a/docs/v1/WidgetMessageDisplay.md b/docs/v1/WidgetMessageDisplay.md index ae04dcf69175..8a6591a3b53f 100644 --- a/docs/v1/WidgetMessageDisplay.md +++ b/docs/v1/WidgetMessageDisplay.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::WidgetMessageDisplay.new() ``` - diff --git a/docs/v1/WidgetMonitorSummaryDisplayFormat.md b/docs/v1/WidgetMonitorSummaryDisplayFormat.md index be131318d895..918f4112edb9 100644 --- a/docs/v1/WidgetMonitorSummaryDisplayFormat.md +++ b/docs/v1/WidgetMonitorSummaryDisplayFormat.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::WidgetMonitorSummaryDisplayFormat.new() ``` - diff --git a/docs/v1/WidgetMonitorSummarySort.md b/docs/v1/WidgetMonitorSummarySort.md index f9082da5006d..07a6c897ecb7 100644 --- a/docs/v1/WidgetMonitorSummarySort.md +++ b/docs/v1/WidgetMonitorSummarySort.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::WidgetMonitorSummarySort.new() ``` - diff --git a/docs/v1/WidgetNodeType.md b/docs/v1/WidgetNodeType.md index 94fa6093c8a7..43b483f6ab4d 100644 --- a/docs/v1/WidgetNodeType.md +++ b/docs/v1/WidgetNodeType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::WidgetNodeType.new() ``` - diff --git a/docs/v1/WidgetOrderBy.md b/docs/v1/WidgetOrderBy.md index 463d834e7ab1..292859b7bd2d 100644 --- a/docs/v1/WidgetOrderBy.md +++ b/docs/v1/WidgetOrderBy.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::WidgetOrderBy.new() ``` - diff --git a/docs/v1/WidgetPalette.md b/docs/v1/WidgetPalette.md index 96688dccd523..ef88ca2d4f43 100644 --- a/docs/v1/WidgetPalette.md +++ b/docs/v1/WidgetPalette.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::WidgetPalette.new() ``` - diff --git a/docs/v1/WidgetRequestStyle.md b/docs/v1/WidgetRequestStyle.md index 158e35c7c0a5..39d7bb380f3d 100644 --- a/docs/v1/WidgetRequestStyle.md +++ b/docs/v1/WidgetRequestStyle.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **line_type** | [**WidgetLineType**](WidgetLineType.md) | | [optional] | -| **line_width** | [**WidgetLineWidth**](WidgetLineWidth.md) | | [optional] | -| **palette** | **String** | Color palette to apply to the widget. | [optional] | +| Name | Type | Description | Notes | +| -------------- | ----------------------------------------- | ------------------------------------- | ---------- | +| **line_type** | [**WidgetLineType**](WidgetLineType.md) | | [optional] | +| **line_width** | [**WidgetLineWidth**](WidgetLineWidth.md) | | [optional] | +| **palette** | **String** | Color palette to apply to the widget. | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::WidgetRequestStyle.new( palette: null ) ``` - diff --git a/docs/v1/WidgetServiceSummaryDisplayFormat.md b/docs/v1/WidgetServiceSummaryDisplayFormat.md index ece2e6450645..1ccca81a10be 100644 --- a/docs/v1/WidgetServiceSummaryDisplayFormat.md +++ b/docs/v1/WidgetServiceSummaryDisplayFormat.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::WidgetServiceSummaryDisplayFormat.new() ``` - diff --git a/docs/v1/WidgetSizeFormat.md b/docs/v1/WidgetSizeFormat.md index 6af8455fd208..a858dce3e83f 100644 --- a/docs/v1/WidgetSizeFormat.md +++ b/docs/v1/WidgetSizeFormat.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::WidgetSizeFormat.new() ``` - diff --git a/docs/v1/WidgetSort.md b/docs/v1/WidgetSort.md index ed8340d4eeb0..6b959339c2e5 100644 --- a/docs/v1/WidgetSort.md +++ b/docs/v1/WidgetSort.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::WidgetSort.new() ``` - diff --git a/docs/v1/WidgetStyle.md b/docs/v1/WidgetStyle.md index e99957543c00..7932b5a5b207 100644 --- a/docs/v1/WidgetStyle.md +++ b/docs/v1/WidgetStyle.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| ----------- | ---------- | ------------------------------------- | ---------- | | **palette** | **String** | Color palette to apply to the widget. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::WidgetStyle.new( palette: null ) ``` - diff --git a/docs/v1/WidgetSummaryType.md b/docs/v1/WidgetSummaryType.md index a80796255b5a..52cc4ad0193a 100644 --- a/docs/v1/WidgetSummaryType.md +++ b/docs/v1/WidgetSummaryType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::WidgetSummaryType.new() ``` - diff --git a/docs/v1/WidgetTextAlign.md b/docs/v1/WidgetTextAlign.md index b426a0058a46..208671f72793 100644 --- a/docs/v1/WidgetTextAlign.md +++ b/docs/v1/WidgetTextAlign.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::WidgetTextAlign.new() ``` - diff --git a/docs/v1/WidgetTickEdge.md b/docs/v1/WidgetTickEdge.md index 0788a656c94b..cb89202266d4 100644 --- a/docs/v1/WidgetTickEdge.md +++ b/docs/v1/WidgetTickEdge.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::WidgetTickEdge.new() ``` - diff --git a/docs/v1/WidgetTime.md b/docs/v1/WidgetTime.md index af700a9a2ab3..6e401dacc424 100644 --- a/docs/v1/WidgetTime.md +++ b/docs/v1/WidgetTime.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **live_span** | [**WidgetLiveSpan**](WidgetLiveSpan.md) | | [optional] | +| Name | Type | Description | Notes | +| ------------- | --------------------------------------- | ----------- | ---------- | +| **live_span** | [**WidgetLiveSpan**](WidgetLiveSpan.md) | | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::WidgetTime.new( live_span: null ) ``` - diff --git a/docs/v1/WidgetTimeWindows.md b/docs/v1/WidgetTimeWindows.md index a669882800a6..0fe645dbf2f2 100644 --- a/docs/v1/WidgetTimeWindows.md +++ b/docs/v1/WidgetTimeWindows.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::WidgetTimeWindows.new() ``` - diff --git a/docs/v1/WidgetVerticalAlign.md b/docs/v1/WidgetVerticalAlign.md index 2865bd7b5352..c9379b98ae16 100644 --- a/docs/v1/WidgetVerticalAlign.md +++ b/docs/v1/WidgetVerticalAlign.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::WidgetVerticalAlign.new() ``` - diff --git a/docs/v1/WidgetViewMode.md b/docs/v1/WidgetViewMode.md index b440babe905b..b7367b4afde1 100644 --- a/docs/v1/WidgetViewMode.md +++ b/docs/v1/WidgetViewMode.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::WidgetViewMode.new() ``` - diff --git a/docs/v1/WidgetVizType.md b/docs/v1/WidgetVizType.md index 6d7789926254..651a781c2d85 100644 --- a/docs/v1/WidgetVizType.md +++ b/docs/v1/WidgetVizType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v1' instance = DatadogAPIClient::V1::WidgetVizType.new() ``` - diff --git a/docs/v2/APIErrorResponse.md b/docs/v2/APIErrorResponse.md index f2e565e18090..d140b8a58cf2 100644 --- a/docs/v2/APIErrorResponse.md +++ b/docs/v2/APIErrorResponse.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **errors** | **Array<String>** | A list of errors. | | +| Name | Type | Description | Notes | +| ---------- | ----------------------- | ----------------- | ----- | +| **errors** | **Array<String>** | A list of errors. | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::APIErrorResponse.new( errors: null ) ``` - diff --git a/docs/v2/APIKeyCreateAttributes.md b/docs/v2/APIKeyCreateAttributes.md index 079a7d5df814..068edfa24b2e 100644 --- a/docs/v2/APIKeyCreateAttributes.md +++ b/docs/v2/APIKeyCreateAttributes.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **name** | **String** | Name of the API key. | | +| Name | Type | Description | Notes | +| -------- | ---------- | -------------------- | ----- | +| **name** | **String** | Name of the API key. | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::APIKeyCreateAttributes.new( name: API Key for submitting metrics ) ``` - diff --git a/docs/v2/APIKeyCreateData.md b/docs/v2/APIKeyCreateData.md index 8bfb14344009..c427ac8a2898 100644 --- a/docs/v2/APIKeyCreateData.md +++ b/docs/v2/APIKeyCreateData.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**APIKeyCreateAttributes**](APIKeyCreateAttributes.md) | | | -| **type** | [**APIKeysType**](APIKeysType.md) | | [default to 'api_keys'] | +| Name | Type | Description | Notes | +| -------------- | ------------------------------------------------------- | ----------- | ------------------------------- | +| **attributes** | [**APIKeyCreateAttributes**](APIKeyCreateAttributes.md) | | | +| **type** | [**APIKeysType**](APIKeysType.md) | | [default to 'api_keys'] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::APIKeyCreateData.new( type: null ) ``` - diff --git a/docs/v2/APIKeyCreateRequest.md b/docs/v2/APIKeyCreateRequest.md index 87689d7e9a84..3476de860e4e 100644 --- a/docs/v2/APIKeyCreateRequest.md +++ b/docs/v2/APIKeyCreateRequest.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**APIKeyCreateData**](APIKeyCreateData.md) | | | +| Name | Type | Description | Notes | +| -------- | ------------------------------------------- | ----------- | ----- | +| **data** | [**APIKeyCreateData**](APIKeyCreateData.md) | | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::APIKeyCreateRequest.new( data: null ) ``` - diff --git a/docs/v2/APIKeyRelationships.md b/docs/v2/APIKeyRelationships.md index bcd34ce5beba..1ffaecf0786b 100644 --- a/docs/v2/APIKeyRelationships.md +++ b/docs/v2/APIKeyRelationships.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **created_by** | [**RelationshipToUser**](RelationshipToUser.md) | | [optional] | -| **modified_by** | [**RelationshipToUser**](RelationshipToUser.md) | | [optional] | +| Name | Type | Description | Notes | +| --------------- | ----------------------------------------------- | ----------- | ---------- | +| **created_by** | [**RelationshipToUser**](RelationshipToUser.md) | | [optional] | +| **modified_by** | [**RelationshipToUser**](RelationshipToUser.md) | | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::APIKeyRelationships.new( modified_by: null ) ``` - diff --git a/docs/v2/APIKeyResponse.md b/docs/v2/APIKeyResponse.md index 9ae3b1a3e570..9f654b2b8e47 100644 --- a/docs/v2/APIKeyResponse.md +++ b/docs/v2/APIKeyResponse.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**FullAPIKey**](FullAPIKey.md) | | [optional] | +| Name | Type | Description | Notes | +| ------------ | ---------------------------------------------------------------------------- | ---------------------------------------- | ---------- | +| **data** | [**FullAPIKey**](FullAPIKey.md) | | [optional] | | **included** | [**Array<APIKeyResponseIncludedItem>**](APIKeyResponseIncludedItem.md) | Array of objects related to the API key. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::APIKeyResponse.new( included: null ) ``` - diff --git a/docs/v2/APIKeyResponseIncludedItem.md b/docs/v2/APIKeyResponseIncludedItem.md index d17384163e3c..fe7889c64fab 100644 --- a/docs/v2/APIKeyResponseIncludedItem.md +++ b/docs/v2/APIKeyResponseIncludedItem.md @@ -36,12 +36,11 @@ DatadogAPIClient::V2::APIKeyResponseIncludedItem.build(data_that_doesnt_match) #### Parameters -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| -------- | --------- | -------------------------------------------------- | | **data** | **Mixed** | data to be matched against the list of oneOf items | #### Return type - `User` - `nil` (if no type matches) - diff --git a/docs/v2/APIKeyUpdateAttributes.md b/docs/v2/APIKeyUpdateAttributes.md index 33ae139546a6..5105e606c747 100644 --- a/docs/v2/APIKeyUpdateAttributes.md +++ b/docs/v2/APIKeyUpdateAttributes.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **name** | **String** | Name of the API key. | | +| Name | Type | Description | Notes | +| -------- | ---------- | -------------------- | ----- | +| **name** | **String** | Name of the API key. | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::APIKeyUpdateAttributes.new( name: API Key for submitting metrics ) ``` - diff --git a/docs/v2/APIKeyUpdateData.md b/docs/v2/APIKeyUpdateData.md index 08c08107f4f9..8c76041eab5c 100644 --- a/docs/v2/APIKeyUpdateData.md +++ b/docs/v2/APIKeyUpdateData.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**APIKeyUpdateAttributes**](APIKeyUpdateAttributes.md) | | | -| **id** | **String** | ID of the API key. | | -| **type** | [**APIKeysType**](APIKeysType.md) | | [default to 'api_keys'] | +| Name | Type | Description | Notes | +| -------------- | ------------------------------------------------------- | ------------------ | ------------------------------- | +| **attributes** | [**APIKeyUpdateAttributes**](APIKeyUpdateAttributes.md) | | | +| **id** | **String** | ID of the API key. | | +| **type** | [**APIKeysType**](APIKeysType.md) | | [default to 'api_keys'] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V2::APIKeyUpdateData.new( type: null ) ``` - diff --git a/docs/v2/APIKeyUpdateRequest.md b/docs/v2/APIKeyUpdateRequest.md index 639080c1c5e1..221ee01fa3b1 100644 --- a/docs/v2/APIKeyUpdateRequest.md +++ b/docs/v2/APIKeyUpdateRequest.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**APIKeyUpdateData**](APIKeyUpdateData.md) | | | +| Name | Type | Description | Notes | +| -------- | ------------------------------------------- | ----------- | ----- | +| **data** | [**APIKeyUpdateData**](APIKeyUpdateData.md) | | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::APIKeyUpdateRequest.new( data: null ) ``` - diff --git a/docs/v2/APIKeysResponse.md b/docs/v2/APIKeysResponse.md index 8d2ce43e00bd..6de74a3b1968 100644 --- a/docs/v2/APIKeysResponse.md +++ b/docs/v2/APIKeysResponse.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**Array<PartialAPIKey>**](PartialAPIKey.md) | Array of API keys. | [optional] | +| Name | Type | Description | Notes | +| ------------ | ---------------------------------------------------------------------------- | ---------------------------------------- | ---------- | +| **data** | [**Array<PartialAPIKey>**](PartialAPIKey.md) | Array of API keys. | [optional] | | **included** | [**Array<APIKeyResponseIncludedItem>**](APIKeyResponseIncludedItem.md) | Array of objects related to the API key. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::APIKeysResponse.new( included: null ) ``` - diff --git a/docs/v2/APIKeysSort.md b/docs/v2/APIKeysSort.md index d584d26cd7bb..eee49f93dbdc 100644 --- a/docs/v2/APIKeysSort.md +++ b/docs/v2/APIKeysSort.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::APIKeysSort.new() ``` - diff --git a/docs/v2/APIKeysType.md b/docs/v2/APIKeysType.md index f91b03b0e0b5..b12a8b88dbe4 100644 --- a/docs/v2/APIKeysType.md +++ b/docs/v2/APIKeysType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::APIKeysType.new() ``` - diff --git a/docs/v2/ApplicationKeyCreateAttributes.md b/docs/v2/ApplicationKeyCreateAttributes.md index 6e34d5bee936..c945cbd3069b 100644 --- a/docs/v2/ApplicationKeyCreateAttributes.md +++ b/docs/v2/ApplicationKeyCreateAttributes.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **name** | **String** | Name of the application key. | | +| Name | Type | Description | Notes | +| -------- | ---------- | ---------------------------- | ----- | +| **name** | **String** | Name of the application key. | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::ApplicationKeyCreateAttributes.new( name: Application Key for submitting metrics ) ``` - diff --git a/docs/v2/ApplicationKeyCreateData.md b/docs/v2/ApplicationKeyCreateData.md index 440a651cfd51..cdc41f09135e 100644 --- a/docs/v2/ApplicationKeyCreateData.md +++ b/docs/v2/ApplicationKeyCreateData.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**ApplicationKeyCreateAttributes**](ApplicationKeyCreateAttributes.md) | | | -| **type** | [**ApplicationKeysType**](ApplicationKeysType.md) | | [default to 'application_keys'] | +| Name | Type | Description | Notes | +| -------------- | ----------------------------------------------------------------------- | ----------- | --------------------------------------- | +| **attributes** | [**ApplicationKeyCreateAttributes**](ApplicationKeyCreateAttributes.md) | | | +| **type** | [**ApplicationKeysType**](ApplicationKeysType.md) | | [default to 'application_keys'] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::ApplicationKeyCreateData.new( type: null ) ``` - diff --git a/docs/v2/ApplicationKeyCreateRequest.md b/docs/v2/ApplicationKeyCreateRequest.md index 2edf1313b0dd..8c2154246a87 100644 --- a/docs/v2/ApplicationKeyCreateRequest.md +++ b/docs/v2/ApplicationKeyCreateRequest.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**ApplicationKeyCreateData**](ApplicationKeyCreateData.md) | | | +| Name | Type | Description | Notes | +| -------- | ----------------------------------------------------------- | ----------- | ----- | +| **data** | [**ApplicationKeyCreateData**](ApplicationKeyCreateData.md) | | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::ApplicationKeyCreateRequest.new( data: null ) ``` - diff --git a/docs/v2/ApplicationKeyRelationships.md b/docs/v2/ApplicationKeyRelationships.md index 6f01c07a75c3..057432d1bce1 100644 --- a/docs/v2/ApplicationKeyRelationships.md +++ b/docs/v2/ApplicationKeyRelationships.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **owned_by** | [**RelationshipToUser**](RelationshipToUser.md) | | [optional] | +| Name | Type | Description | Notes | +| ------------ | ----------------------------------------------- | ----------- | ---------- | +| **owned_by** | [**RelationshipToUser**](RelationshipToUser.md) | | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::ApplicationKeyRelationships.new( owned_by: null ) ``` - diff --git a/docs/v2/ApplicationKeyResponse.md b/docs/v2/ApplicationKeyResponse.md index af3ba9f1bba7..49a63805d487 100644 --- a/docs/v2/ApplicationKeyResponse.md +++ b/docs/v2/ApplicationKeyResponse.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**FullApplicationKey**](FullApplicationKey.md) | | [optional] | +| Name | Type | Description | Notes | +| ------------ | -------------------------------------------------------------------------------------------- | ------------------------------------------------ | ---------- | +| **data** | [**FullApplicationKey**](FullApplicationKey.md) | | [optional] | | **included** | [**Array<ApplicationKeyResponseIncludedItem>**](ApplicationKeyResponseIncludedItem.md) | Array of objects related to the application key. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::ApplicationKeyResponse.new( included: null ) ``` - diff --git a/docs/v2/ApplicationKeyResponseIncludedItem.md b/docs/v2/ApplicationKeyResponseIncludedItem.md index b786ade0676b..2d57f17c53fa 100644 --- a/docs/v2/ApplicationKeyResponseIncludedItem.md +++ b/docs/v2/ApplicationKeyResponseIncludedItem.md @@ -37,8 +37,8 @@ DatadogAPIClient::V2::ApplicationKeyResponseIncludedItem.build(data_that_doesnt_ #### Parameters -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| -------- | --------- | -------------------------------------------------- | | **data** | **Mixed** | data to be matched against the list of oneOf items | #### Return type @@ -46,4 +46,3 @@ DatadogAPIClient::V2::ApplicationKeyResponseIncludedItem.build(data_that_doesnt_ - `Role` - `User` - `nil` (if no type matches) - diff --git a/docs/v2/ApplicationKeyUpdateAttributes.md b/docs/v2/ApplicationKeyUpdateAttributes.md index 1d82492d9800..079bfc284bef 100644 --- a/docs/v2/ApplicationKeyUpdateAttributes.md +++ b/docs/v2/ApplicationKeyUpdateAttributes.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **name** | **String** | Name of the application key. | | +| Name | Type | Description | Notes | +| -------- | ---------- | ---------------------------- | ----- | +| **name** | **String** | Name of the application key. | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::ApplicationKeyUpdateAttributes.new( name: Application Key for submitting metrics ) ``` - diff --git a/docs/v2/ApplicationKeyUpdateData.md b/docs/v2/ApplicationKeyUpdateData.md index b68307275584..536ae27191e9 100644 --- a/docs/v2/ApplicationKeyUpdateData.md +++ b/docs/v2/ApplicationKeyUpdateData.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**ApplicationKeyUpdateAttributes**](ApplicationKeyUpdateAttributes.md) | | | -| **id** | **String** | ID of the application key. | | -| **type** | [**ApplicationKeysType**](ApplicationKeysType.md) | | [default to 'application_keys'] | +| Name | Type | Description | Notes | +| -------------- | ----------------------------------------------------------------------- | -------------------------- | --------------------------------------- | +| **attributes** | [**ApplicationKeyUpdateAttributes**](ApplicationKeyUpdateAttributes.md) | | | +| **id** | **String** | ID of the application key. | | +| **type** | [**ApplicationKeysType**](ApplicationKeysType.md) | | [default to 'application_keys'] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V2::ApplicationKeyUpdateData.new( type: null ) ``` - diff --git a/docs/v2/ApplicationKeyUpdateRequest.md b/docs/v2/ApplicationKeyUpdateRequest.md index 40b1282c5e35..d736fbe6557e 100644 --- a/docs/v2/ApplicationKeyUpdateRequest.md +++ b/docs/v2/ApplicationKeyUpdateRequest.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**ApplicationKeyUpdateData**](ApplicationKeyUpdateData.md) | | | +| Name | Type | Description | Notes | +| -------- | ----------------------------------------------------------- | ----------- | ----- | +| **data** | [**ApplicationKeyUpdateData**](ApplicationKeyUpdateData.md) | | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::ApplicationKeyUpdateRequest.new( data: null ) ``` - diff --git a/docs/v2/ApplicationKeysSort.md b/docs/v2/ApplicationKeysSort.md index ceae0c27665c..69053a7df41e 100644 --- a/docs/v2/ApplicationKeysSort.md +++ b/docs/v2/ApplicationKeysSort.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::ApplicationKeysSort.new() ``` - diff --git a/docs/v2/ApplicationKeysType.md b/docs/v2/ApplicationKeysType.md index d692054cb959..d5d944033479 100644 --- a/docs/v2/ApplicationKeysType.md +++ b/docs/v2/ApplicationKeysType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::ApplicationKeysType.new() ``` - diff --git a/docs/v2/Creator.md b/docs/v2/Creator.md index e98435a9ea23..b63c0c82620e 100644 --- a/docs/v2/Creator.md +++ b/docs/v2/Creator.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **email** | **String** | Email of the creator. | [optional] | +| Name | Type | Description | Notes | +| ---------- | ---------- | ---------------------- | ---------- | +| **email** | **String** | Email of the creator. | [optional] | | **handle** | **String** | Handle of the creator. | [optional] | -| **name** | **String** | Name of the creator. | [optional] | +| **name** | **String** | Name of the creator. | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V2::Creator.new( name: null ) ``` - diff --git a/docs/v2/DashboardListAddItemsRequest.md b/docs/v2/DashboardListAddItemsRequest.md index 7d932e824f48..fe72889954e4 100644 --- a/docs/v2/DashboardListAddItemsRequest.md +++ b/docs/v2/DashboardListAddItemsRequest.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| -------------- | ------------------------------------------------------------------------ | --------------------------------------------- | ---------- | | **dashboards** | [**Array<DashboardListItemRequest>**](DashboardListItemRequest.md) | List of dashboards to add the dashboard list. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::DashboardListAddItemsRequest.new( dashboards: null ) ``` - diff --git a/docs/v2/DashboardListAddItemsResponse.md b/docs/v2/DashboardListAddItemsResponse.md index 449c3970e9ca..70f86c758e53 100644 --- a/docs/v2/DashboardListAddItemsResponse.md +++ b/docs/v2/DashboardListAddItemsResponse.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| ---------------------------- | -------------------------------------------------------------------------- | ----------------------------------------------- | ---------- | | **added_dashboards_to_list** | [**Array<DashboardListItemResponse>**](DashboardListItemResponse.md) | List of dashboards added to the dashboard list. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::DashboardListAddItemsResponse.new( added_dashboards_to_list: null ) ``` - diff --git a/docs/v2/DashboardListDeleteItemsRequest.md b/docs/v2/DashboardListDeleteItemsRequest.md index 59d349965912..c6ac3d0d5d6d 100644 --- a/docs/v2/DashboardListDeleteItemsRequest.md +++ b/docs/v2/DashboardListDeleteItemsRequest.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| -------------- | ------------------------------------------------------------------------ | ----------------------------------------------------- | ---------- | | **dashboards** | [**Array<DashboardListItemRequest>**](DashboardListItemRequest.md) | List of dashboards to delete from the dashboard list. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::DashboardListDeleteItemsRequest.new( dashboards: null ) ``` - diff --git a/docs/v2/DashboardListDeleteItemsResponse.md b/docs/v2/DashboardListDeleteItemsResponse.md index 222eeb1e5fb7..20bc98def245 100644 --- a/docs/v2/DashboardListDeleteItemsResponse.md +++ b/docs/v2/DashboardListDeleteItemsResponse.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| -------------------------------- | -------------------------------------------------------------------------- | --------------------------------------------------- | ---------- | | **deleted_dashboards_from_list** | [**Array<DashboardListItemResponse>**](DashboardListItemResponse.md) | List of dashboards deleted from the dashboard list. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::DashboardListDeleteItemsResponse.new( deleted_dashboards_from_list: null ) ``` - diff --git a/docs/v2/DashboardListItem.md b/docs/v2/DashboardListItem.md index dcf8eca9cd5e..56bf255df36e 100644 --- a/docs/v2/DashboardListItem.md +++ b/docs/v2/DashboardListItem.md @@ -2,20 +2,20 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **author** | [**Creator**](Creator.md) | | [optional] | -| **created** | **Time** | Date of creation of the dashboard. | [optional][readonly] | -| **icon** | **String** | URL to the icon of the dashboard. | [optional][readonly] | -| **id** | **String** | ID of the dashboard. | | -| **is_favorite** | **Boolean** | Whether or not the dashboard is in the favorites. | [optional][readonly] | -| **is_read_only** | **Boolean** | Whether or not the dashboard is read only. | [optional][readonly] | -| **is_shared** | **Boolean** | Whether the dashboard is publicly shared or not. | [optional][readonly] | -| **modified** | **Time** | Date of last edition of the dashboard. | [optional][readonly] | -| **popularity** | **Integer** | Popularity of the dashboard. | [optional][readonly] | -| **title** | **String** | Title of the dashboard. | [optional][readonly] | -| **type** | [**DashboardType**](DashboardType.md) | | | -| **url** | **String** | URL path to the dashboard. | [optional][readonly] | +| Name | Type | Description | Notes | +| ---------------- | ------------------------------------- | ------------------------------------------------- | -------------------- | +| **author** | [**Creator**](Creator.md) | | [optional] | +| **created** | **Time** | Date of creation of the dashboard. | [optional][readonly] | +| **icon** | **String** | URL to the icon of the dashboard. | [optional][readonly] | +| **id** | **String** | ID of the dashboard. | | +| **is_favorite** | **Boolean** | Whether or not the dashboard is in the favorites. | [optional][readonly] | +| **is_read_only** | **Boolean** | Whether or not the dashboard is read only. | [optional][readonly] | +| **is_shared** | **Boolean** | Whether the dashboard is publicly shared or not. | [optional][readonly] | +| **modified** | **Time** | Date of last edition of the dashboard. | [optional][readonly] | +| **popularity** | **Integer** | Popularity of the dashboard. | [optional][readonly] | +| **title** | **String** | Title of the dashboard. | [optional][readonly] | +| **type** | [**DashboardType**](DashboardType.md) | | | +| **url** | **String** | URL path to the dashboard. | [optional][readonly] | ## Example @@ -37,4 +37,3 @@ instance = DatadogAPIClient::V2::DashboardListItem.new( url: null ) ``` - diff --git a/docs/v2/DashboardListItemRequest.md b/docs/v2/DashboardListItemRequest.md index 5a4c22fa9ff7..853b1507bac6 100644 --- a/docs/v2/DashboardListItemRequest.md +++ b/docs/v2/DashboardListItemRequest.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **id** | **String** | ID of the dashboard. | | -| **type** | [**DashboardType**](DashboardType.md) | | | +| Name | Type | Description | Notes | +| -------- | ------------------------------------- | -------------------- | ----- | +| **id** | **String** | ID of the dashboard. | | +| **type** | [**DashboardType**](DashboardType.md) | | | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::DashboardListItemRequest.new( type: null ) ``` - diff --git a/docs/v2/DashboardListItemResponse.md b/docs/v2/DashboardListItemResponse.md index a0052550ca60..62856a8194db 100644 --- a/docs/v2/DashboardListItemResponse.md +++ b/docs/v2/DashboardListItemResponse.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **id** | **String** | ID of the dashboard. | [readonly] | -| **type** | [**DashboardType**](DashboardType.md) | | | +| Name | Type | Description | Notes | +| -------- | ------------------------------------- | -------------------- | ---------- | +| **id** | **String** | ID of the dashboard. | [readonly] | +| **type** | [**DashboardType**](DashboardType.md) | | | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::DashboardListItemResponse.new( type: null ) ``` - diff --git a/docs/v2/DashboardListItems.md b/docs/v2/DashboardListItems.md index 4a17953f7597..19fd2550b1b0 100644 --- a/docs/v2/DashboardListItems.md +++ b/docs/v2/DashboardListItems.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **dashboards** | [**Array<DashboardListItem>**](DashboardListItem.md) | List of dashboards in the dashboard list. | | -| **total** | **Integer** | Number of dashboards in the dashboard list. | [optional][readonly] | +| Name | Type | Description | Notes | +| -------------- | ---------------------------------------------------------- | ------------------------------------------- | -------------------- | +| **dashboards** | [**Array<DashboardListItem>**](DashboardListItem.md) | List of dashboards in the dashboard list. | | +| **total** | **Integer** | Number of dashboards in the dashboard list. | [optional][readonly] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::DashboardListItems.new( total: null ) ``` - diff --git a/docs/v2/DashboardListUpdateItemsRequest.md b/docs/v2/DashboardListUpdateItemsRequest.md index 35ae7ffa60a4..9caa07b6e313 100644 --- a/docs/v2/DashboardListUpdateItemsRequest.md +++ b/docs/v2/DashboardListUpdateItemsRequest.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| -------------- | ------------------------------------------------------------------------ | --------------------------------------------------- | ---------- | | **dashboards** | [**Array<DashboardListItemRequest>**](DashboardListItemRequest.md) | List of dashboards to update the dashboard list to. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::DashboardListUpdateItemsRequest.new( dashboards: null ) ``` - diff --git a/docs/v2/DashboardListUpdateItemsResponse.md b/docs/v2/DashboardListUpdateItemsResponse.md index 7f0325aefbb0..a2398d9a70bc 100644 --- a/docs/v2/DashboardListUpdateItemsResponse.md +++ b/docs/v2/DashboardListUpdateItemsResponse.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| -------------- | -------------------------------------------------------------------------- | ----------------------------------------- | ---------- | | **dashboards** | [**Array<DashboardListItemResponse>**](DashboardListItemResponse.md) | List of dashboards in the dashboard list. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::DashboardListUpdateItemsResponse.new( dashboards: null ) ``` - diff --git a/docs/v2/DashboardListsAPI.md b/docs/v2/DashboardListsAPI.md index 282085b11fb8..527800f9e0cf 100644 --- a/docs/v2/DashboardListsAPI.md +++ b/docs/v2/DashboardListsAPI.md @@ -2,13 +2,12 @@ All URIs are relative to *https://api.datadoghq.com* -| Method | HTTP request | Description | -| ------ | ------------ | ----------- | -| [**create_dashboard_list_items**](DashboardListsAPI.md#create_dashboard_list_items) | **POST** /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards | Add Items to a Dashboard List | +| Method | HTTP request | Description | +| ----------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | ---------------------------------- | +| [**create_dashboard_list_items**](DashboardListsAPI.md#create_dashboard_list_items) | **POST** /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards | Add Items to a Dashboard List | | [**delete_dashboard_list_items**](DashboardListsAPI.md#delete_dashboard_list_items) | **DELETE** /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards | Delete items from a dashboard list | -| [**get_dashboard_list_items**](DashboardListsAPI.md#get_dashboard_list_items) | **GET** /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards | Get items of a Dashboard List | -| [**update_dashboard_list_items**](DashboardListsAPI.md#update_dashboard_list_items) | **PUT** /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards | Update items of a dashboard list | - +| [**get_dashboard_list_items**](DashboardListsAPI.md#get_dashboard_list_items) | **GET** /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards | Get items of a Dashboard List | +| [**update_dashboard_list_items**](DashboardListsAPI.md#update_dashboard_list_items) | **PUT** /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards | Update items of a dashboard list | ## create_dashboard_list_items @@ -53,10 +52,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **dashboard_list_id** | **Integer** | ID of the dashboard list to add items to. | | -| **body** | [**DashboardListAddItemsRequest**](DashboardListAddItemsRequest.md) | Dashboards to add to the dashboard list. | | +| Name | Type | Description | Notes | +| --------------------- | ------------------------------------------------------------------- | ----------------------------------------- | ----- | +| **dashboard_list_id** | **Integer** | ID of the dashboard list to add items to. | | +| **body** | [**DashboardListAddItemsRequest**](DashboardListAddItemsRequest.md) | Dashboards to add to the dashboard list. | | ### Return type @@ -71,7 +70,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## delete_dashboard_list_items > delete_dashboard_list_items(dashboard_list_id, body) @@ -115,10 +113,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **dashboard_list_id** | **Integer** | ID of the dashboard list to delete items from. | | -| **body** | [**DashboardListDeleteItemsRequest**](DashboardListDeleteItemsRequest.md) | Dashboards to delete from the dashboard list. | | +| Name | Type | Description | Notes | +| --------------------- | ------------------------------------------------------------------------- | ---------------------------------------------- | ----- | +| **dashboard_list_id** | **Integer** | ID of the dashboard list to delete items from. | | +| **body** | [**DashboardListDeleteItemsRequest**](DashboardListDeleteItemsRequest.md) | Dashboards to delete from the dashboard list. | | ### Return type @@ -133,7 +131,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## get_dashboard_list_items > get_dashboard_list_items(dashboard_list_id) @@ -176,9 +173,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **dashboard_list_id** | **Integer** | ID of the dashboard list to get items from. | | +| Name | Type | Description | Notes | +| --------------------- | ----------- | ------------------------------------------- | ----- | +| **dashboard_list_id** | **Integer** | ID of the dashboard list to get items from. | | ### Return type @@ -193,7 +190,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## update_dashboard_list_items > update_dashboard_list_items(dashboard_list_id, body) @@ -237,10 +233,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **dashboard_list_id** | **Integer** | ID of the dashboard list to update items from. | | -| **body** | [**DashboardListUpdateItemsRequest**](DashboardListUpdateItemsRequest.md) | New dashboards of the dashboard list. | | +| Name | Type | Description | Notes | +| --------------------- | ------------------------------------------------------------------------- | ---------------------------------------------- | ----- | +| **dashboard_list_id** | **Integer** | ID of the dashboard list to update items from. | | +| **body** | [**DashboardListUpdateItemsRequest**](DashboardListUpdateItemsRequest.md) | New dashboards of the dashboard list. | | ### Return type @@ -254,4 +250,3 @@ end - **Content-Type**: application/json - **Accept**: application/json - diff --git a/docs/v2/DashboardType.md b/docs/v2/DashboardType.md index 397bd6ba577c..6c45104d4eac 100644 --- a/docs/v2/DashboardType.md +++ b/docs/v2/DashboardType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::DashboardType.new() ``` - diff --git a/docs/v2/FullAPIKey.md b/docs/v2/FullAPIKey.md index a5951a65c453..02b942e2406e 100644 --- a/docs/v2/FullAPIKey.md +++ b/docs/v2/FullAPIKey.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**FullAPIKeyAttributes**](FullAPIKeyAttributes.md) | | [optional] | -| **id** | **String** | ID of the API key. | [optional] | -| **relationships** | [**APIKeyRelationships**](APIKeyRelationships.md) | | [optional] | -| **type** | [**APIKeysType**](APIKeysType.md) | | [optional][default to 'api_keys'] | +| Name | Type | Description | Notes | +| ----------------- | --------------------------------------------------- | ------------------ | ----------------------------------------- | +| **attributes** | [**FullAPIKeyAttributes**](FullAPIKeyAttributes.md) | | [optional] | +| **id** | **String** | ID of the API key. | [optional] | +| **relationships** | [**APIKeyRelationships**](APIKeyRelationships.md) | | [optional] | +| **type** | [**APIKeysType**](APIKeysType.md) | | [optional][default to 'api_keys'] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V2::FullAPIKey.new( type: null ) ``` - diff --git a/docs/v2/FullAPIKeyAttributes.md b/docs/v2/FullAPIKeyAttributes.md index f9b4287b538c..db1cd6db2fd7 100644 --- a/docs/v2/FullAPIKeyAttributes.md +++ b/docs/v2/FullAPIKeyAttributes.md @@ -2,13 +2,13 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **created_at** | **String** | Creation date of the API key. | [optional][readonly] | -| **key** | **String** | The API key. | [optional][readonly] | -| **last4** | **String** | The last four characters of the API key. | [optional][readonly] | -| **modified_at** | **String** | Date the API key was last modified. | [optional][readonly] | -| **name** | **String** | Name of the API key. | [optional] | +| Name | Type | Description | Notes | +| --------------- | ---------- | ---------------------------------------- | -------------------- | +| **created_at** | **String** | Creation date of the API key. | [optional][readonly] | +| **key** | **String** | The API key. | [optional][readonly] | +| **last4** | **String** | The last four characters of the API key. | [optional][readonly] | +| **modified_at** | **String** | Date the API key was last modified. | [optional][readonly] | +| **name** | **String** | Name of the API key. | [optional] | ## Example @@ -23,4 +23,3 @@ instance = DatadogAPIClient::V2::FullAPIKeyAttributes.new( name: API Key for submitting metrics ) ``` - diff --git a/docs/v2/FullApplicationKey.md b/docs/v2/FullApplicationKey.md index 70d28821f357..fbfe5026e585 100644 --- a/docs/v2/FullApplicationKey.md +++ b/docs/v2/FullApplicationKey.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**FullApplicationKeyAttributes**](FullApplicationKeyAttributes.md) | | [optional] | -| **id** | **String** | ID of the application key. | [optional] | -| **relationships** | [**ApplicationKeyRelationships**](ApplicationKeyRelationships.md) | | [optional] | -| **type** | [**ApplicationKeysType**](ApplicationKeysType.md) | | [optional][default to 'application_keys'] | +| Name | Type | Description | Notes | +| ----------------- | ------------------------------------------------------------------- | -------------------------- | ------------------------------------------------- | +| **attributes** | [**FullApplicationKeyAttributes**](FullApplicationKeyAttributes.md) | | [optional] | +| **id** | **String** | ID of the application key. | [optional] | +| **relationships** | [**ApplicationKeyRelationships**](ApplicationKeyRelationships.md) | | [optional] | +| **type** | [**ApplicationKeysType**](ApplicationKeysType.md) | | [optional][default to 'application_keys'] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V2::FullApplicationKey.new( type: null ) ``` - diff --git a/docs/v2/FullApplicationKeyAttributes.md b/docs/v2/FullApplicationKeyAttributes.md index 869a0fff4dcc..45f86be68be7 100644 --- a/docs/v2/FullApplicationKeyAttributes.md +++ b/docs/v2/FullApplicationKeyAttributes.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **created_at** | **String** | Creation date of the application key. | [optional][readonly] | -| **key** | **String** | The application key. | [optional][readonly] | -| **last4** | **String** | The last four characters of the application key. | [optional][readonly] | -| **name** | **String** | Name of the application key. | [optional] | +| Name | Type | Description | Notes | +| -------------- | ---------- | ------------------------------------------------ | -------------------- | +| **created_at** | **String** | Creation date of the application key. | [optional][readonly] | +| **key** | **String** | The application key. | [optional][readonly] | +| **last4** | **String** | The last four characters of the application key. | [optional][readonly] | +| **name** | **String** | Name of the application key. | [optional] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V2::FullApplicationKeyAttributes.new( name: Application Key for submitting metrics ) ``` - diff --git a/docs/v2/IncidentCreateAttributes.md b/docs/v2/IncidentCreateAttributes.md index 22865cea6ec5..84c3b3d1c5f2 100644 --- a/docs/v2/IncidentCreateAttributes.md +++ b/docs/v2/IncidentCreateAttributes.md @@ -2,13 +2,13 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **customer_impacted** | **Boolean** | A flag indicating whether the incident caused customer impact. | | -| **fields** | [**Hash<String, IncidentFieldAttributes>**](IncidentFieldAttributes.md) | A condensed view of the user-defined fields for which to create initial selections. | [optional] | -| **initial_cells** | [**Array<IncidentTimelineCellCreateAttributes>**](IncidentTimelineCellCreateAttributes.md) | An array of initial timeline cells to be placed at the beginning of the incident timeline. | [optional] | -| **notification_handles** | [**Array<IncidentNotificationHandle>**](IncidentNotificationHandle.md) | Notification handles that will be notified of the incident at creation. | [optional] | -| **title** | **String** | The title of the incident, which summarizes what happened. | | +| Name | Type | Description | Notes | +| ------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ---------- | +| **customer_impacted** | **Boolean** | A flag indicating whether the incident caused customer impact. | | +| **fields** | [**Hash<String, IncidentFieldAttributes>**](IncidentFieldAttributes.md) | A condensed view of the user-defined fields for which to create initial selections. | [optional] | +| **initial_cells** | [**Array<IncidentTimelineCellCreateAttributes>**](IncidentTimelineCellCreateAttributes.md) | An array of initial timeline cells to be placed at the beginning of the incident timeline. | [optional] | +| **notification_handles** | [**Array<IncidentNotificationHandle>**](IncidentNotificationHandle.md) | Notification handles that will be notified of the incident at creation. | [optional] | +| **title** | **String** | The title of the incident, which summarizes what happened. | | ## Example @@ -23,4 +23,3 @@ instance = DatadogAPIClient::V2::IncidentCreateAttributes.new( title: A test incident title ) ``` - diff --git a/docs/v2/IncidentCreateData.md b/docs/v2/IncidentCreateData.md index 7690ba8c7745..47b6fd29c9c0 100644 --- a/docs/v2/IncidentCreateData.md +++ b/docs/v2/IncidentCreateData.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**IncidentCreateAttributes**](IncidentCreateAttributes.md) | | | -| **relationships** | [**IncidentCreateRelationships**](IncidentCreateRelationships.md) | | [optional] | -| **type** | [**IncidentType**](IncidentType.md) | | [default to 'incidents'] | +| Name | Type | Description | Notes | +| ----------------- | ----------------------------------------------------------------- | ----------- | -------------------------------- | +| **attributes** | [**IncidentCreateAttributes**](IncidentCreateAttributes.md) | | | +| **relationships** | [**IncidentCreateRelationships**](IncidentCreateRelationships.md) | | [optional] | +| **type** | [**IncidentType**](IncidentType.md) | | [default to 'incidents'] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V2::IncidentCreateData.new( type: null ) ``` - diff --git a/docs/v2/IncidentCreateRelationships.md b/docs/v2/IncidentCreateRelationships.md index 612106ead8e4..53cf1bee0a3e 100644 --- a/docs/v2/IncidentCreateRelationships.md +++ b/docs/v2/IncidentCreateRelationships.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **commander** | [**RelationshipToUser**](RelationshipToUser.md) | | | +| Name | Type | Description | Notes | +| ------------- | ----------------------------------------------- | ----------- | ----- | +| **commander** | [**RelationshipToUser**](RelationshipToUser.md) | | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::IncidentCreateRelationships.new( commander: null ) ``` - diff --git a/docs/v2/IncidentCreateRequest.md b/docs/v2/IncidentCreateRequest.md index 0c1647b87e7f..d207454a26b6 100644 --- a/docs/v2/IncidentCreateRequest.md +++ b/docs/v2/IncidentCreateRequest.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**IncidentCreateData**](IncidentCreateData.md) | | | +| Name | Type | Description | Notes | +| -------- | ----------------------------------------------- | ----------- | ----- | +| **data** | [**IncidentCreateData**](IncidentCreateData.md) | | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::IncidentCreateRequest.new( data: null ) ``` - diff --git a/docs/v2/IncidentFieldAttributes.md b/docs/v2/IncidentFieldAttributes.md index ae1eeb89f5d4..b98ffaac2ffa 100644 --- a/docs/v2/IncidentFieldAttributes.md +++ b/docs/v2/IncidentFieldAttributes.md @@ -37,8 +37,8 @@ DatadogAPIClient::V2::IncidentFieldAttributes.build(data_that_doesnt_match) #### Parameters -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| -------- | --------- | -------------------------------------------------- | | **data** | **Mixed** | data to be matched against the list of oneOf items | #### Return type @@ -46,4 +46,3 @@ DatadogAPIClient::V2::IncidentFieldAttributes.build(data_that_doesnt_match) - `IncidentFieldAttributesMultipleValue` - `IncidentFieldAttributesSingleValue` - `nil` (if no type matches) - diff --git a/docs/v2/IncidentFieldAttributesMultipleValue.md b/docs/v2/IncidentFieldAttributesMultipleValue.md index ba62b120f88c..74600b0ef1ad 100644 --- a/docs/v2/IncidentFieldAttributesMultipleValue.md +++ b/docs/v2/IncidentFieldAttributesMultipleValue.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **type** | [**IncidentFieldAttributesValueType**](IncidentFieldAttributesValueType.md) | | [optional][default to 'multiselect'] | -| **value** | **Array<String>** | The multiple values selected for this field. | [optional] | +| Name | Type | Description | Notes | +| --------- | --------------------------------------------------------------------------- | -------------------------------------------- | -------------------------------------------- | +| **type** | [**IncidentFieldAttributesValueType**](IncidentFieldAttributesValueType.md) | | [optional][default to 'multiselect'] | +| **value** | **Array<String>** | The multiple values selected for this field. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::IncidentFieldAttributesMultipleValue.new( value: ["1.0","1.1"] ) ``` - diff --git a/docs/v2/IncidentFieldAttributesSingleValue.md b/docs/v2/IncidentFieldAttributesSingleValue.md index 582c73340fdb..efe2d2189357 100644 --- a/docs/v2/IncidentFieldAttributesSingleValue.md +++ b/docs/v2/IncidentFieldAttributesSingleValue.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **type** | [**IncidentFieldAttributesSingleValueType**](IncidentFieldAttributesSingleValueType.md) | | [optional][default to 'dropdown'] | -| **value** | **String** | The single value selected for this field. | [optional] | +| Name | Type | Description | Notes | +| --------- | --------------------------------------------------------------------------------------- | ----------------------------------------- | ----------------------------------------- | +| **type** | [**IncidentFieldAttributesSingleValueType**](IncidentFieldAttributesSingleValueType.md) | | [optional][default to 'dropdown'] | +| **value** | **String** | The single value selected for this field. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::IncidentFieldAttributesSingleValue.new( value: SEV-1 ) ``` - diff --git a/docs/v2/IncidentFieldAttributesSingleValueType.md b/docs/v2/IncidentFieldAttributesSingleValueType.md index ef86d6d9370e..3598c102be13 100644 --- a/docs/v2/IncidentFieldAttributesSingleValueType.md +++ b/docs/v2/IncidentFieldAttributesSingleValueType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::IncidentFieldAttributesSingleValueType.new() ``` - diff --git a/docs/v2/IncidentFieldAttributesValueType.md b/docs/v2/IncidentFieldAttributesValueType.md index 905bd2dffef5..a43f5af7dde7 100644 --- a/docs/v2/IncidentFieldAttributesValueType.md +++ b/docs/v2/IncidentFieldAttributesValueType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::IncidentFieldAttributesValueType.new() ``` - diff --git a/docs/v2/IncidentIntegrationMetadataType.md b/docs/v2/IncidentIntegrationMetadataType.md index 8a3032521f6a..db9d6751040f 100644 --- a/docs/v2/IncidentIntegrationMetadataType.md +++ b/docs/v2/IncidentIntegrationMetadataType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::IncidentIntegrationMetadataType.new() ``` - diff --git a/docs/v2/IncidentNotificationHandle.md b/docs/v2/IncidentNotificationHandle.md index 5bed4a6674b3..1f9d769444ff 100644 --- a/docs/v2/IncidentNotificationHandle.md +++ b/docs/v2/IncidentNotificationHandle.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **display_name** | **String** | The name of the notified handle. | [optional] | -| **handle** | **String** | The email address used for the notification. | [optional] | +| Name | Type | Description | Notes | +| ---------------- | ---------- | -------------------------------------------- | ---------- | +| **display_name** | **String** | The name of the notified handle. | [optional] | +| **handle** | **String** | The email address used for the notification. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::IncidentNotificationHandle.new( handle: @test.user@test.com ) ``` - diff --git a/docs/v2/IncidentPostmortemType.md b/docs/v2/IncidentPostmortemType.md index 767ada7150cb..7bef209b7486 100644 --- a/docs/v2/IncidentPostmortemType.md +++ b/docs/v2/IncidentPostmortemType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::IncidentPostmortemType.new() ``` - diff --git a/docs/v2/IncidentRelatedObject.md b/docs/v2/IncidentRelatedObject.md index 21d8fb6b16aa..bee494c98de4 100644 --- a/docs/v2/IncidentRelatedObject.md +++ b/docs/v2/IncidentRelatedObject.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::IncidentRelatedObject.new() ``` - diff --git a/docs/v2/IncidentResponse.md b/docs/v2/IncidentResponse.md index a391ba8abbc0..abbc773c8f52 100644 --- a/docs/v2/IncidentResponse.md +++ b/docs/v2/IncidentResponse.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**IncidentResponseData**](IncidentResponseData.md) | | | +| Name | Type | Description | Notes | +| ------------ | -------------------------------------------------------------------------------- | --------------------------------------------------- | -------------------- | +| **data** | [**IncidentResponseData**](IncidentResponseData.md) | | | | **included** | [**Array<IncidentResponseIncludedItem>**](IncidentResponseIncludedItem.md) | Included related resources that the user requested. | [optional][readonly] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::IncidentResponse.new( included: null ) ``` - diff --git a/docs/v2/IncidentResponseAttributes.md b/docs/v2/IncidentResponseAttributes.md index 9dd90696442f..0f13704668cf 100644 --- a/docs/v2/IncidentResponseAttributes.md +++ b/docs/v2/IncidentResponseAttributes.md @@ -2,26 +2,26 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **created** | **Time** | Timestamp when the incident was created. | [optional][readonly] | -| **customer_impact_duration** | **Integer** | Length of the incident's customer impact in seconds. Equals the difference between `customer_impact_start` and `customer_impact_end`. | [optional][readonly] | -| **customer_impact_end** | **Time** | Timestamp when customers were no longer impacted by the incident. | [optional] | -| **customer_impact_scope** | **String** | A summary of the impact customers experienced during the incident. | [optional] | -| **customer_impact_start** | **Time** | Timestamp when customers began being impacted by the incident. | [optional] | -| **customer_impacted** | **Boolean** | A flag indicating whether the incident caused customer impact. | [optional] | -| **detected** | **Time** | Timestamp when the incident was detected. | [optional] | -| **fields** | [**Hash<String, IncidentFieldAttributes>**](IncidentFieldAttributes.md) | A condensed view of the user-defined fields attached to incidents. | [optional] | -| **modified** | **Time** | Timestamp when the incident was last modified. | [optional][readonly] | -| **notification_handles** | [**Array<IncidentNotificationHandle>**](IncidentNotificationHandle.md) | Notification handles that will be notified of the incident during update. | [optional] | -| **postmortem_id** | **String** | The UUID of the postmortem object attached to the incident. | [optional] | -| **public_id** | **Integer** | The monotonically increasing integer ID for the incident. | [optional] | -| **resolved** | **Time** | Timestamp when the incident's state was set to resolved. | [optional] | -| **time_to_detect** | **Integer** | The amount of time in seconds to detect the incident. Equals the difference between `customer_impact_start` and `detected`. | [optional][readonly] | -| **time_to_internal_response** | **Integer** | The amount of time in seconds to call incident after detection. Equals the difference of `detected` and `created`. | [optional][readonly] | -| **time_to_repair** | **Integer** | The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between `customer_impact_end` and `detected`. | [optional][readonly] | -| **time_to_resolve** | **Integer** | The amount of time in seconds to resolve the incident after it was created. Equals the difference between `created` and `resolved`. | [optional][readonly] | -| **title** | **String** | The title of the incident, which summarizes what happened. | | +| Name | Type | Description | Notes | +| ----------------------------- | ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------- | +| **created** | **Time** | Timestamp when the incident was created. | [optional][readonly] | +| **customer_impact_duration** | **Integer** | Length of the incident's customer impact in seconds. Equals the difference between `customer_impact_start` and `customer_impact_end`. | [optional][readonly] | +| **customer_impact_end** | **Time** | Timestamp when customers were no longer impacted by the incident. | [optional] | +| **customer_impact_scope** | **String** | A summary of the impact customers experienced during the incident. | [optional] | +| **customer_impact_start** | **Time** | Timestamp when customers began being impacted by the incident. | [optional] | +| **customer_impacted** | **Boolean** | A flag indicating whether the incident caused customer impact. | [optional] | +| **detected** | **Time** | Timestamp when the incident was detected. | [optional] | +| **fields** | [**Hash<String, IncidentFieldAttributes>**](IncidentFieldAttributes.md) | A condensed view of the user-defined fields attached to incidents. | [optional] | +| **modified** | **Time** | Timestamp when the incident was last modified. | [optional][readonly] | +| **notification_handles** | [**Array<IncidentNotificationHandle>**](IncidentNotificationHandle.md) | Notification handles that will be notified of the incident during update. | [optional] | +| **postmortem_id** | **String** | The UUID of the postmortem object attached to the incident. | [optional] | +| **public_id** | **Integer** | The monotonically increasing integer ID for the incident. | [optional] | +| **resolved** | **Time** | Timestamp when the incident's state was set to resolved. | [optional] | +| **time_to_detect** | **Integer** | The amount of time in seconds to detect the incident. Equals the difference between `customer_impact_start` and `detected`. | [optional][readonly] | +| **time_to_internal_response** | **Integer** | The amount of time in seconds to call incident after detection. Equals the difference of `detected` and `created`. | [optional][readonly] | +| **time_to_repair** | **Integer** | The amount of time in seconds to resolve customer impact after detecting the issue. Equals the difference between `customer_impact_end` and `detected`. | [optional][readonly] | +| **time_to_resolve** | **Integer** | The amount of time in seconds to resolve the incident after it was created. Equals the difference between `created` and `resolved`. | [optional][readonly] | +| **title** | **String** | The title of the incident, which summarizes what happened. | | ## Example @@ -49,4 +49,3 @@ instance = DatadogAPIClient::V2::IncidentResponseAttributes.new( title: A test incident title ) ``` - diff --git a/docs/v2/IncidentResponseData.md b/docs/v2/IncidentResponseData.md index bd9eed81bb31..6283fa37a5dd 100644 --- a/docs/v2/IncidentResponseData.md +++ b/docs/v2/IncidentResponseData.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**IncidentResponseAttributes**](IncidentResponseAttributes.md) | | [optional] | -| **id** | **String** | The incident's ID. | | -| **relationships** | [**IncidentResponseRelationships**](IncidentResponseRelationships.md) | | [optional] | -| **type** | [**IncidentType**](IncidentType.md) | | [default to 'incidents'] | +| Name | Type | Description | Notes | +| ----------------- | --------------------------------------------------------------------- | ---------------------- | -------------------------------- | +| **attributes** | [**IncidentResponseAttributes**](IncidentResponseAttributes.md) | | [optional] | +| **id** | **String** | The incident's ID. | | +| **relationships** | [**IncidentResponseRelationships**](IncidentResponseRelationships.md) | | [optional] | +| **type** | [**IncidentType**](IncidentType.md) | | [default to 'incidents'] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V2::IncidentResponseData.new( type: null ) ``` - diff --git a/docs/v2/IncidentResponseIncludedItem.md b/docs/v2/IncidentResponseIncludedItem.md index 6bc9f51b6dfb..2bc557faadb0 100644 --- a/docs/v2/IncidentResponseIncludedItem.md +++ b/docs/v2/IncidentResponseIncludedItem.md @@ -36,12 +36,11 @@ DatadogAPIClient::V2::IncidentResponseIncludedItem.build(data_that_doesnt_match) #### Parameters -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| -------- | --------- | -------------------------------------------------- | | **data** | **Mixed** | data to be matched against the list of oneOf items | #### Return type - `User` - `nil` (if no type matches) - diff --git a/docs/v2/IncidentResponseRelationships.md b/docs/v2/IncidentResponseRelationships.md index 0230bfc2cd39..d9a47941c297 100644 --- a/docs/v2/IncidentResponseRelationships.md +++ b/docs/v2/IncidentResponseRelationships.md @@ -2,13 +2,13 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **commander_user** | [**RelationshipToUser**](RelationshipToUser.md) | | [optional] | -| **created_by_user** | [**RelationshipToUser**](RelationshipToUser.md) | | [optional] | -| **integrations** | [**RelationshipToIncidentIntegrationMetadatas**](RelationshipToIncidentIntegrationMetadatas.md) | | [optional] | -| **last_modified_by_user** | [**RelationshipToUser**](RelationshipToUser.md) | | [optional] | -| **postmortem** | [**RelationshipToIncidentPostmortem**](RelationshipToIncidentPostmortem.md) | | [optional] | +| Name | Type | Description | Notes | +| ------------------------- | ----------------------------------------------------------------------------------------------- | ----------- | ---------- | +| **commander_user** | [**RelationshipToUser**](RelationshipToUser.md) | | [optional] | +| **created_by_user** | [**RelationshipToUser**](RelationshipToUser.md) | | [optional] | +| **integrations** | [**RelationshipToIncidentIntegrationMetadatas**](RelationshipToIncidentIntegrationMetadatas.md) | | [optional] | +| **last_modified_by_user** | [**RelationshipToUser**](RelationshipToUser.md) | | [optional] | +| **postmortem** | [**RelationshipToIncidentPostmortem**](RelationshipToIncidentPostmortem.md) | | [optional] | ## Example @@ -23,4 +23,3 @@ instance = DatadogAPIClient::V2::IncidentResponseRelationships.new( postmortem: null ) ``` - diff --git a/docs/v2/IncidentServiceCreateAttributes.md b/docs/v2/IncidentServiceCreateAttributes.md index 3c4ed1d4bb03..9f28517dfe80 100644 --- a/docs/v2/IncidentServiceCreateAttributes.md +++ b/docs/v2/IncidentServiceCreateAttributes.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **name** | **String** | Name of the incident service. | | +| Name | Type | Description | Notes | +| -------- | ---------- | ----------------------------- | ----- | +| **name** | **String** | Name of the incident service. | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::IncidentServiceCreateAttributes.new( name: an example service name ) ``` - diff --git a/docs/v2/IncidentServiceCreateData.md b/docs/v2/IncidentServiceCreateData.md index f5e1248bdf9a..2bc96d75aa10 100644 --- a/docs/v2/IncidentServiceCreateData.md +++ b/docs/v2/IncidentServiceCreateData.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**IncidentServiceCreateAttributes**](IncidentServiceCreateAttributes.md) | | [optional] | -| **relationships** | [**IncidentServiceRelationships**](IncidentServiceRelationships.md) | | [optional] | -| **type** | [**IncidentServiceType**](IncidentServiceType.md) | | [default to 'services'] | +| Name | Type | Description | Notes | +| ----------------- | ------------------------------------------------------------------------- | ----------- | ------------------------------- | +| **attributes** | [**IncidentServiceCreateAttributes**](IncidentServiceCreateAttributes.md) | | [optional] | +| **relationships** | [**IncidentServiceRelationships**](IncidentServiceRelationships.md) | | [optional] | +| **type** | [**IncidentServiceType**](IncidentServiceType.md) | | [default to 'services'] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V2::IncidentServiceCreateData.new( type: null ) ``` - diff --git a/docs/v2/IncidentServiceCreateRequest.md b/docs/v2/IncidentServiceCreateRequest.md index ba531ed74298..573821ea8ed7 100644 --- a/docs/v2/IncidentServiceCreateRequest.md +++ b/docs/v2/IncidentServiceCreateRequest.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**IncidentServiceCreateData**](IncidentServiceCreateData.md) | | | +| Name | Type | Description | Notes | +| -------- | ------------------------------------------------------------- | ----------- | ----- | +| **data** | [**IncidentServiceCreateData**](IncidentServiceCreateData.md) | | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::IncidentServiceCreateRequest.new( data: null ) ``` - diff --git a/docs/v2/IncidentServiceIncludedItems.md b/docs/v2/IncidentServiceIncludedItems.md index 030ae8d9e599..e7b0c0894b30 100644 --- a/docs/v2/IncidentServiceIncludedItems.md +++ b/docs/v2/IncidentServiceIncludedItems.md @@ -36,12 +36,11 @@ DatadogAPIClient::V2::IncidentServiceIncludedItems.build(data_that_doesnt_match) #### Parameters -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| -------- | --------- | -------------------------------------------------- | | **data** | **Mixed** | data to be matched against the list of oneOf items | #### Return type - `User` - `nil` (if no type matches) - diff --git a/docs/v2/IncidentServiceRelationships.md b/docs/v2/IncidentServiceRelationships.md index 6b143b136130..d74a89804e44 100644 --- a/docs/v2/IncidentServiceRelationships.md +++ b/docs/v2/IncidentServiceRelationships.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **created_by** | [**RelationshipToUser**](RelationshipToUser.md) | | [optional] | -| **last_modified_by** | [**RelationshipToUser**](RelationshipToUser.md) | | [optional] | +| Name | Type | Description | Notes | +| -------------------- | ----------------------------------------------- | ----------- | ---------- | +| **created_by** | [**RelationshipToUser**](RelationshipToUser.md) | | [optional] | +| **last_modified_by** | [**RelationshipToUser**](RelationshipToUser.md) | | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::IncidentServiceRelationships.new( last_modified_by: null ) ``` - diff --git a/docs/v2/IncidentServiceResponse.md b/docs/v2/IncidentServiceResponse.md index b174d73afb54..b5b60641f0e0 100644 --- a/docs/v2/IncidentServiceResponse.md +++ b/docs/v2/IncidentServiceResponse.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**IncidentServiceResponseData**](IncidentServiceResponseData.md) | | | +| Name | Type | Description | Notes | +| ------------ | -------------------------------------------------------------------------------- | ------------------------------------ | -------------------- | +| **data** | [**IncidentServiceResponseData**](IncidentServiceResponseData.md) | | | | **included** | [**Array<IncidentServiceIncludedItems>**](IncidentServiceIncludedItems.md) | Included objects from relationships. | [optional][readonly] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::IncidentServiceResponse.new( included: null ) ``` - diff --git a/docs/v2/IncidentServiceResponseAttributes.md b/docs/v2/IncidentServiceResponseAttributes.md index 8d869c15239c..5c0aff7ef96d 100644 --- a/docs/v2/IncidentServiceResponseAttributes.md +++ b/docs/v2/IncidentServiceResponseAttributes.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **created** | **Time** | Timestamp of when the incident service was created. | [optional][readonly] | -| **modified** | **Time** | Timestamp of when the incident service was modified. | [optional][readonly] | -| **name** | **String** | Name of the incident service. | [optional] | +| Name | Type | Description | Notes | +| ------------ | ---------- | ---------------------------------------------------- | -------------------- | +| **created** | **Time** | Timestamp of when the incident service was created. | [optional][readonly] | +| **modified** | **Time** | Timestamp of when the incident service was modified. | [optional][readonly] | +| **name** | **String** | Name of the incident service. | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V2::IncidentServiceResponseAttributes.new( name: service name ) ``` - diff --git a/docs/v2/IncidentServiceResponseData.md b/docs/v2/IncidentServiceResponseData.md index 3edd0b6f6b3e..800620c9b964 100644 --- a/docs/v2/IncidentServiceResponseData.md +++ b/docs/v2/IncidentServiceResponseData.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**IncidentServiceResponseAttributes**](IncidentServiceResponseAttributes.md) | | [optional] | -| **id** | **String** | The incident service's ID. | | -| **relationships** | [**IncidentServiceRelationships**](IncidentServiceRelationships.md) | | [optional] | -| **type** | [**IncidentServiceType**](IncidentServiceType.md) | | [default to 'services'] | +| Name | Type | Description | Notes | +| ----------------- | ----------------------------------------------------------------------------- | ------------------------------ | ------------------------------- | +| **attributes** | [**IncidentServiceResponseAttributes**](IncidentServiceResponseAttributes.md) | | [optional] | +| **id** | **String** | The incident service's ID. | | +| **relationships** | [**IncidentServiceRelationships**](IncidentServiceRelationships.md) | | [optional] | +| **type** | [**IncidentServiceType**](IncidentServiceType.md) | | [default to 'services'] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V2::IncidentServiceResponseData.new( type: null ) ``` - diff --git a/docs/v2/IncidentServiceType.md b/docs/v2/IncidentServiceType.md index bc1a39c58f75..b0278cbd6845 100644 --- a/docs/v2/IncidentServiceType.md +++ b/docs/v2/IncidentServiceType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::IncidentServiceType.new() ``` - diff --git a/docs/v2/IncidentServiceUpdateAttributes.md b/docs/v2/IncidentServiceUpdateAttributes.md index 69ede773a54d..35c1836b8521 100644 --- a/docs/v2/IncidentServiceUpdateAttributes.md +++ b/docs/v2/IncidentServiceUpdateAttributes.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **name** | **String** | Name of the incident service. | | +| Name | Type | Description | Notes | +| -------- | ---------- | ----------------------------- | ----- | +| **name** | **String** | Name of the incident service. | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::IncidentServiceUpdateAttributes.new( name: an example service name ) ``` - diff --git a/docs/v2/IncidentServiceUpdateData.md b/docs/v2/IncidentServiceUpdateData.md index 4908311dde2e..51b918a3c528 100644 --- a/docs/v2/IncidentServiceUpdateData.md +++ b/docs/v2/IncidentServiceUpdateData.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**IncidentServiceUpdateAttributes**](IncidentServiceUpdateAttributes.md) | | [optional] | -| **id** | **String** | The incident service's ID. | [optional] | -| **relationships** | [**IncidentServiceRelationships**](IncidentServiceRelationships.md) | | [optional] | -| **type** | [**IncidentServiceType**](IncidentServiceType.md) | | [default to 'services'] | +| Name | Type | Description | Notes | +| ----------------- | ------------------------------------------------------------------------- | ------------------------------ | ------------------------------- | +| **attributes** | [**IncidentServiceUpdateAttributes**](IncidentServiceUpdateAttributes.md) | | [optional] | +| **id** | **String** | The incident service's ID. | [optional] | +| **relationships** | [**IncidentServiceRelationships**](IncidentServiceRelationships.md) | | [optional] | +| **type** | [**IncidentServiceType**](IncidentServiceType.md) | | [default to 'services'] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V2::IncidentServiceUpdateData.new( type: null ) ``` - diff --git a/docs/v2/IncidentServiceUpdateRequest.md b/docs/v2/IncidentServiceUpdateRequest.md index 93f13ede45b3..a88bc6fd7b42 100644 --- a/docs/v2/IncidentServiceUpdateRequest.md +++ b/docs/v2/IncidentServiceUpdateRequest.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**IncidentServiceUpdateData**](IncidentServiceUpdateData.md) | | | +| Name | Type | Description | Notes | +| -------- | ------------------------------------------------------------- | ----------- | ----- | +| **data** | [**IncidentServiceUpdateData**](IncidentServiceUpdateData.md) | | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::IncidentServiceUpdateRequest.new( data: null ) ``` - diff --git a/docs/v2/IncidentServicesAPI.md b/docs/v2/IncidentServicesAPI.md index b9c55b5cb612..572dd0c77c08 100644 --- a/docs/v2/IncidentServicesAPI.md +++ b/docs/v2/IncidentServicesAPI.md @@ -2,14 +2,13 @@ All URIs are relative to *https://api.datadoghq.com* -| Method | HTTP request | Description | -| ------ | ------------ | ----------- | -| [**create_incident_service**](IncidentServicesAPI.md#create_incident_service) | **POST** /api/v2/services | Create a new incident service | +| Method | HTTP request | Description | +| ----------------------------------------------------------------------------- | ---------------------------------------- | ----------------------------------- | +| [**create_incident_service**](IncidentServicesAPI.md#create_incident_service) | **POST** /api/v2/services | Create a new incident service | | [**delete_incident_service**](IncidentServicesAPI.md#delete_incident_service) | **DELETE** /api/v2/services/{service_id} | Delete an existing incident service | -| [**get_incident_service**](IncidentServicesAPI.md#get_incident_service) | **GET** /api/v2/services/{service_id} | Get details of an incident service | -| [**list_incident_services**](IncidentServicesAPI.md#list_incident_services) | **GET** /api/v2/services | Get a list of all incident services | -| [**update_incident_service**](IncidentServicesAPI.md#update_incident_service) | **PATCH** /api/v2/services/{service_id} | Update an existing incident service | - +| [**get_incident_service**](IncidentServicesAPI.md#get_incident_service) | **GET** /api/v2/services/{service_id} | Get details of an incident service | +| [**list_incident_services**](IncidentServicesAPI.md#list_incident_services) | **GET** /api/v2/services | Get a list of all incident services | +| [**update_incident_service**](IncidentServicesAPI.md#update_incident_service) | **PATCH** /api/v2/services/{service_id} | Update an existing incident service | ## create_incident_service @@ -58,9 +57,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**IncidentServiceCreateRequest**](IncidentServiceCreateRequest.md) | Incident Service Payload. | | +| Name | Type | Description | Notes | +| -------- | ------------------------------------------------------------------- | ------------------------- | ----- | +| **body** | [**IncidentServiceCreateRequest**](IncidentServiceCreateRequest.md) | Incident Service Payload. | | ### Return type @@ -75,7 +74,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## delete_incident_service > delete_incident_service(service_id) @@ -122,9 +120,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **service_id** | **String** | The ID of the incident service. | | +| Name | Type | Description | Notes | +| -------------- | ---------- | ------------------------------- | ----- | +| **service_id** | **String** | The ID of the incident service. | | ### Return type @@ -139,7 +137,6 @@ nil (empty response body) - **Content-Type**: Not defined - **Accept**: application/json - ## get_incident_service > get_incident_service(service_id, opts) @@ -191,10 +188,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **service_id** | **String** | The ID of the incident service. | | -| **include** | **IncidentRelatedObject** | Specifies which types of related objects should be included in the response. | [optional] | +| Name | Type | Description | Notes | +| -------------- | ------------------------- | ---------------------------------------------------------------------------- | ---------- | +| **service_id** | **String** | The ID of the incident service. | | +| **include** | **IncidentRelatedObject** | Specifies which types of related objects should be included in the response. | [optional] | ### Return type @@ -209,7 +206,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## list_incident_services > list_incident_services(opts) @@ -262,12 +258,12 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **include** | **IncidentRelatedObject** | Specifies which types of related objects should be included in the response. | [optional] | -| **page_size** | **Integer** | Size for a given page. | [optional][default to 10] | -| **page_offset** | **Integer** | Specific offset to use as the beginning of the returned page. | [optional][default to 0] | -| **filter** | **String** | A search query that filters services by name. | [optional] | +| Name | Type | Description | Notes | +| --------------- | ------------------------- | ---------------------------------------------------------------------------- | ------------------------- | +| **include** | **IncidentRelatedObject** | Specifies which types of related objects should be included in the response. | [optional] | +| **page_size** | **Integer** | Size for a given page. | [optional][default to 10] | +| **page_offset** | **Integer** | Specific offset to use as the beginning of the returned page. | [optional][default to 0] | +| **filter** | **String** | A search query that filters services by name. | [optional] | ### Return type @@ -282,7 +278,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## update_incident_service > update_incident_service(service_id, body) @@ -331,10 +326,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **service_id** | **String** | The ID of the incident service. | | -| **body** | [**IncidentServiceUpdateRequest**](IncidentServiceUpdateRequest.md) | Incident Service Payload. | | +| Name | Type | Description | Notes | +| -------------- | ------------------------------------------------------------------- | ------------------------------- | ----- | +| **service_id** | **String** | The ID of the incident service. | | +| **body** | [**IncidentServiceUpdateRequest**](IncidentServiceUpdateRequest.md) | Incident Service Payload. | | ### Return type @@ -348,4 +343,3 @@ end - **Content-Type**: application/json - **Accept**: application/json - diff --git a/docs/v2/IncidentServicesResponse.md b/docs/v2/IncidentServicesResponse.md index ca6e334906d2..fa12a1530ed4 100644 --- a/docs/v2/IncidentServicesResponse.md +++ b/docs/v2/IncidentServicesResponse.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**Array<IncidentServiceResponseData>**](IncidentServiceResponseData.md) | An array of incident services. | | +| Name | Type | Description | Notes | +| ------------ | -------------------------------------------------------------------------------- | ---------------------------------------------------- | -------------------- | +| **data** | [**Array<IncidentServiceResponseData>**](IncidentServiceResponseData.md) | An array of incident services. | | | **included** | [**Array<IncidentServiceIncludedItems>**](IncidentServiceIncludedItems.md) | Included related resources which the user requested. | [optional][readonly] | -| **meta** | [**IncidentServicesResponseMeta**](IncidentServicesResponseMeta.md) | | [optional] | +| **meta** | [**IncidentServicesResponseMeta**](IncidentServicesResponseMeta.md) | | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V2::IncidentServicesResponse.new( meta: null ) ``` - diff --git a/docs/v2/IncidentServicesResponseMeta.md b/docs/v2/IncidentServicesResponseMeta.md index c26b3ece9dbc..861a633485b5 100644 --- a/docs/v2/IncidentServicesResponseMeta.md +++ b/docs/v2/IncidentServicesResponseMeta.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **pagination** | [**IncidentServicesResponseMetaPagination**](IncidentServicesResponseMetaPagination.md) | | [optional] | +| Name | Type | Description | Notes | +| -------------- | --------------------------------------------------------------------------------------- | ----------- | ---------- | +| **pagination** | [**IncidentServicesResponseMetaPagination**](IncidentServicesResponseMetaPagination.md) | | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::IncidentServicesResponseMeta.new( pagination: null ) ``` - diff --git a/docs/v2/IncidentServicesResponseMetaPagination.md b/docs/v2/IncidentServicesResponseMetaPagination.md index c4098391ba0b..74760fe184fb 100644 --- a/docs/v2/IncidentServicesResponseMetaPagination.md +++ b/docs/v2/IncidentServicesResponseMetaPagination.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| --------------- | ----------- | ----------------------------------------------------------------------------------------------------------- | ---------- | | **next_offset** | **Integer** | The index of the first element in the next page of results. Equal to page size added to the current offset. | [optional] | -| **offset** | **Integer** | The index of the first element in the results. | [optional] | -| **size** | **Integer** | Maximum size of pages to return. | [optional] | +| **offset** | **Integer** | The index of the first element in the results. | [optional] | +| **size** | **Integer** | Maximum size of pages to return. | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V2::IncidentServicesResponseMetaPagination.new( size: 1000 ) ``` - diff --git a/docs/v2/IncidentTeamCreateAttributes.md b/docs/v2/IncidentTeamCreateAttributes.md index fba246d5b05b..c9a8f2a14a15 100644 --- a/docs/v2/IncidentTeamCreateAttributes.md +++ b/docs/v2/IncidentTeamCreateAttributes.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **name** | **String** | Name of the incident team. | | +| Name | Type | Description | Notes | +| -------- | ---------- | -------------------------- | ----- | +| **name** | **String** | Name of the incident team. | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::IncidentTeamCreateAttributes.new( name: team name ) ``` - diff --git a/docs/v2/IncidentTeamCreateData.md b/docs/v2/IncidentTeamCreateData.md index 913aba616088..29df9afa9519 100644 --- a/docs/v2/IncidentTeamCreateData.md +++ b/docs/v2/IncidentTeamCreateData.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**IncidentTeamCreateAttributes**](IncidentTeamCreateAttributes.md) | | [optional] | -| **relationships** | [**IncidentTeamRelationships**](IncidentTeamRelationships.md) | | [optional] | -| **type** | [**IncidentTeamType**](IncidentTeamType.md) | | [default to 'teams'] | +| Name | Type | Description | Notes | +| ----------------- | ------------------------------------------------------------------- | ----------- | ---------------------------- | +| **attributes** | [**IncidentTeamCreateAttributes**](IncidentTeamCreateAttributes.md) | | [optional] | +| **relationships** | [**IncidentTeamRelationships**](IncidentTeamRelationships.md) | | [optional] | +| **type** | [**IncidentTeamType**](IncidentTeamType.md) | | [default to 'teams'] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V2::IncidentTeamCreateData.new( type: null ) ``` - diff --git a/docs/v2/IncidentTeamCreateRequest.md b/docs/v2/IncidentTeamCreateRequest.md index 1f1c0985151e..f75cafef0011 100644 --- a/docs/v2/IncidentTeamCreateRequest.md +++ b/docs/v2/IncidentTeamCreateRequest.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**IncidentTeamCreateData**](IncidentTeamCreateData.md) | | | +| Name | Type | Description | Notes | +| -------- | ------------------------------------------------------- | ----------- | ----- | +| **data** | [**IncidentTeamCreateData**](IncidentTeamCreateData.md) | | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::IncidentTeamCreateRequest.new( data: null ) ``` - diff --git a/docs/v2/IncidentTeamIncludedItems.md b/docs/v2/IncidentTeamIncludedItems.md index a7578fdb73ae..de7b53924b8e 100644 --- a/docs/v2/IncidentTeamIncludedItems.md +++ b/docs/v2/IncidentTeamIncludedItems.md @@ -36,12 +36,11 @@ DatadogAPIClient::V2::IncidentTeamIncludedItems.build(data_that_doesnt_match) #### Parameters -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| -------- | --------- | -------------------------------------------------- | | **data** | **Mixed** | data to be matched against the list of oneOf items | #### Return type - `User` - `nil` (if no type matches) - diff --git a/docs/v2/IncidentTeamRelationships.md b/docs/v2/IncidentTeamRelationships.md index 114beee7c15e..2e917a7b7bb8 100644 --- a/docs/v2/IncidentTeamRelationships.md +++ b/docs/v2/IncidentTeamRelationships.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **created_by** | [**RelationshipToUser**](RelationshipToUser.md) | | [optional] | -| **last_modified_by** | [**RelationshipToUser**](RelationshipToUser.md) | | [optional] | +| Name | Type | Description | Notes | +| -------------------- | ----------------------------------------------- | ----------- | ---------- | +| **created_by** | [**RelationshipToUser**](RelationshipToUser.md) | | [optional] | +| **last_modified_by** | [**RelationshipToUser**](RelationshipToUser.md) | | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::IncidentTeamRelationships.new( last_modified_by: null ) ``` - diff --git a/docs/v2/IncidentTeamResponse.md b/docs/v2/IncidentTeamResponse.md index 62f89207f804..0413a22479fa 100644 --- a/docs/v2/IncidentTeamResponse.md +++ b/docs/v2/IncidentTeamResponse.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**IncidentTeamResponseData**](IncidentTeamResponseData.md) | | | +| Name | Type | Description | Notes | +| ------------ | -------------------------------------------------------------------------- | ------------------------------------ | -------------------- | +| **data** | [**IncidentTeamResponseData**](IncidentTeamResponseData.md) | | | | **included** | [**Array<IncidentTeamIncludedItems>**](IncidentTeamIncludedItems.md) | Included objects from relationships. | [optional][readonly] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::IncidentTeamResponse.new( included: null ) ``` - diff --git a/docs/v2/IncidentTeamResponseAttributes.md b/docs/v2/IncidentTeamResponseAttributes.md index eadffa9d23a7..e6fc58a81828 100644 --- a/docs/v2/IncidentTeamResponseAttributes.md +++ b/docs/v2/IncidentTeamResponseAttributes.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **created** | **Time** | Timestamp of when the incident team was created. | [optional][readonly] | -| **modified** | **Time** | Timestamp of when the incident team was modified. | [optional][readonly] | -| **name** | **String** | Name of the incident team. | [optional] | +| Name | Type | Description | Notes | +| ------------ | ---------- | ------------------------------------------------- | -------------------- | +| **created** | **Time** | Timestamp of when the incident team was created. | [optional][readonly] | +| **modified** | **Time** | Timestamp of when the incident team was modified. | [optional][readonly] | +| **name** | **String** | Name of the incident team. | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V2::IncidentTeamResponseAttributes.new( name: team name ) ``` - diff --git a/docs/v2/IncidentTeamResponseData.md b/docs/v2/IncidentTeamResponseData.md index 710f27b8527b..389c3ac25463 100644 --- a/docs/v2/IncidentTeamResponseData.md +++ b/docs/v2/IncidentTeamResponseData.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**IncidentTeamResponseAttributes**](IncidentTeamResponseAttributes.md) | | [optional] | -| **id** | **String** | The incident team's ID. | [optional] | -| **relationships** | [**IncidentTeamRelationships**](IncidentTeamRelationships.md) | | [optional] | -| **type** | [**IncidentTeamType**](IncidentTeamType.md) | | [optional][default to 'teams'] | +| Name | Type | Description | Notes | +| ----------------- | ----------------------------------------------------------------------- | --------------------------- | -------------------------------------- | +| **attributes** | [**IncidentTeamResponseAttributes**](IncidentTeamResponseAttributes.md) | | [optional] | +| **id** | **String** | The incident team's ID. | [optional] | +| **relationships** | [**IncidentTeamRelationships**](IncidentTeamRelationships.md) | | [optional] | +| **type** | [**IncidentTeamType**](IncidentTeamType.md) | | [optional][default to 'teams'] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V2::IncidentTeamResponseData.new( type: null ) ``` - diff --git a/docs/v2/IncidentTeamType.md b/docs/v2/IncidentTeamType.md index 567c563896ed..16842d4a2cf1 100644 --- a/docs/v2/IncidentTeamType.md +++ b/docs/v2/IncidentTeamType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::IncidentTeamType.new() ``` - diff --git a/docs/v2/IncidentTeamUpdateAttributes.md b/docs/v2/IncidentTeamUpdateAttributes.md index caa9887cc781..991c1429854d 100644 --- a/docs/v2/IncidentTeamUpdateAttributes.md +++ b/docs/v2/IncidentTeamUpdateAttributes.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **name** | **String** | Name of the incident team. | | +| Name | Type | Description | Notes | +| -------- | ---------- | -------------------------- | ----- | +| **name** | **String** | Name of the incident team. | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::IncidentTeamUpdateAttributes.new( name: team name ) ``` - diff --git a/docs/v2/IncidentTeamUpdateData.md b/docs/v2/IncidentTeamUpdateData.md index 350a2dcf98c9..acf56e1c0cea 100644 --- a/docs/v2/IncidentTeamUpdateData.md +++ b/docs/v2/IncidentTeamUpdateData.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**IncidentTeamUpdateAttributes**](IncidentTeamUpdateAttributes.md) | | [optional] | -| **id** | **String** | The incident team's ID. | [optional] | -| **relationships** | [**IncidentTeamRelationships**](IncidentTeamRelationships.md) | | [optional] | -| **type** | [**IncidentTeamType**](IncidentTeamType.md) | | [default to 'teams'] | +| Name | Type | Description | Notes | +| ----------------- | ------------------------------------------------------------------- | --------------------------- | ---------------------------- | +| **attributes** | [**IncidentTeamUpdateAttributes**](IncidentTeamUpdateAttributes.md) | | [optional] | +| **id** | **String** | The incident team's ID. | [optional] | +| **relationships** | [**IncidentTeamRelationships**](IncidentTeamRelationships.md) | | [optional] | +| **type** | [**IncidentTeamType**](IncidentTeamType.md) | | [default to 'teams'] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V2::IncidentTeamUpdateData.new( type: null ) ``` - diff --git a/docs/v2/IncidentTeamUpdateRequest.md b/docs/v2/IncidentTeamUpdateRequest.md index a613963fc4ce..98bc81b644d7 100644 --- a/docs/v2/IncidentTeamUpdateRequest.md +++ b/docs/v2/IncidentTeamUpdateRequest.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**IncidentTeamUpdateData**](IncidentTeamUpdateData.md) | | | +| Name | Type | Description | Notes | +| -------- | ------------------------------------------------------- | ----------- | ----- | +| **data** | [**IncidentTeamUpdateData**](IncidentTeamUpdateData.md) | | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::IncidentTeamUpdateRequest.new( data: null ) ``` - diff --git a/docs/v2/IncidentTeamsAPI.md b/docs/v2/IncidentTeamsAPI.md index a0974fc58c35..e6d45462e48b 100644 --- a/docs/v2/IncidentTeamsAPI.md +++ b/docs/v2/IncidentTeamsAPI.md @@ -2,14 +2,13 @@ All URIs are relative to *https://api.datadoghq.com* -| Method | HTTP request | Description | -| ------ | ------------ | ----------- | -| [**create_incident_team**](IncidentTeamsAPI.md#create_incident_team) | **POST** /api/v2/teams | Create a new incident team | +| Method | HTTP request | Description | +| -------------------------------------------------------------------- | ---------------------------------- | -------------------------------- | +| [**create_incident_team**](IncidentTeamsAPI.md#create_incident_team) | **POST** /api/v2/teams | Create a new incident team | | [**delete_incident_team**](IncidentTeamsAPI.md#delete_incident_team) | **DELETE** /api/v2/teams/{team_id} | Delete an existing incident team | -| [**get_incident_team**](IncidentTeamsAPI.md#get_incident_team) | **GET** /api/v2/teams/{team_id} | Get details of an incident team | -| [**list_incident_teams**](IncidentTeamsAPI.md#list_incident_teams) | **GET** /api/v2/teams | Get a list of all incident teams | -| [**update_incident_team**](IncidentTeamsAPI.md#update_incident_team) | **PATCH** /api/v2/teams/{team_id} | Update an existing incident team | - +| [**get_incident_team**](IncidentTeamsAPI.md#get_incident_team) | **GET** /api/v2/teams/{team_id} | Get details of an incident team | +| [**list_incident_teams**](IncidentTeamsAPI.md#list_incident_teams) | **GET** /api/v2/teams | Get a list of all incident teams | +| [**update_incident_team**](IncidentTeamsAPI.md#update_incident_team) | **PATCH** /api/v2/teams/{team_id} | Update an existing incident team | ## create_incident_team @@ -58,9 +57,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**IncidentTeamCreateRequest**](IncidentTeamCreateRequest.md) | Incident Team Payload. | | +| Name | Type | Description | Notes | +| -------- | ------------------------------------------------------------- | ---------------------- | ----- | +| **body** | [**IncidentTeamCreateRequest**](IncidentTeamCreateRequest.md) | Incident Team Payload. | | ### Return type @@ -75,7 +74,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## delete_incident_team > delete_incident_team(team_id) @@ -122,9 +120,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **team_id** | **String** | The ID of the incident team. | | +| Name | Type | Description | Notes | +| ----------- | ---------- | ---------------------------- | ----- | +| **team_id** | **String** | The ID of the incident team. | | ### Return type @@ -139,7 +137,6 @@ nil (empty response body) - **Content-Type**: Not defined - **Accept**: application/json - ## get_incident_team > get_incident_team(team_id, opts) @@ -191,9 +188,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **team_id** | **String** | The ID of the incident team. | | +| Name | Type | Description | Notes | +| ----------- | ------------------------- | ---------------------------------------------------------------------------- | ---------- | +| **team_id** | **String** | The ID of the incident team. | | | **include** | **IncidentRelatedObject** | Specifies which types of related objects should be included in the response. | [optional] | ### Return type @@ -209,7 +206,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## list_incident_teams > list_incident_teams(opts) @@ -262,12 +258,12 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **include** | **IncidentRelatedObject** | Specifies which types of related objects should be included in the response. | [optional] | -| **page_size** | **Integer** | Size for a given page. | [optional][default to 10] | -| **page_offset** | **Integer** | Specific offset to use as the beginning of the returned page. | [optional][default to 0] | -| **filter** | **String** | A search query that filters teams by name. | [optional] | +| Name | Type | Description | Notes | +| --------------- | ------------------------- | ---------------------------------------------------------------------------- | ------------------------- | +| **include** | **IncidentRelatedObject** | Specifies which types of related objects should be included in the response. | [optional] | +| **page_size** | **Integer** | Size for a given page. | [optional][default to 10] | +| **page_offset** | **Integer** | Specific offset to use as the beginning of the returned page. | [optional][default to 0] | +| **filter** | **String** | A search query that filters teams by name. | [optional] | ### Return type @@ -282,7 +278,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## update_incident_team > update_incident_team(team_id, body) @@ -331,10 +326,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **team_id** | **String** | The ID of the incident team. | | -| **body** | [**IncidentTeamUpdateRequest**](IncidentTeamUpdateRequest.md) | Incident Team Payload. | | +| Name | Type | Description | Notes | +| ----------- | ------------------------------------------------------------- | ---------------------------- | ----- | +| **team_id** | **String** | The ID of the incident team. | | +| **body** | [**IncidentTeamUpdateRequest**](IncidentTeamUpdateRequest.md) | Incident Team Payload. | | ### Return type @@ -348,4 +343,3 @@ end - **Content-Type**: application/json - **Accept**: application/json - diff --git a/docs/v2/IncidentTeamsResponse.md b/docs/v2/IncidentTeamsResponse.md index 8ec27666ac70..6ec75eb1a8ab 100644 --- a/docs/v2/IncidentTeamsResponse.md +++ b/docs/v2/IncidentTeamsResponse.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**Array<IncidentTeamResponseData>**](IncidentTeamResponseData.md) | An array of incident teams. | | +| Name | Type | Description | Notes | +| ------------ | -------------------------------------------------------------------------- | ---------------------------------------------------- | -------------------- | +| **data** | [**Array<IncidentTeamResponseData>**](IncidentTeamResponseData.md) | An array of incident teams. | | | **included** | [**Array<IncidentTeamIncludedItems>**](IncidentTeamIncludedItems.md) | Included related resources which the user requested. | [optional][readonly] | -| **meta** | [**IncidentServicesResponseMeta**](IncidentServicesResponseMeta.md) | | [optional] | +| **meta** | [**IncidentServicesResponseMeta**](IncidentServicesResponseMeta.md) | | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V2::IncidentTeamsResponse.new( meta: null ) ``` - diff --git a/docs/v2/IncidentTimelineCellCreateAttributes.md b/docs/v2/IncidentTimelineCellCreateAttributes.md index 380b3f387786..bf894b0ff09f 100644 --- a/docs/v2/IncidentTimelineCellCreateAttributes.md +++ b/docs/v2/IncidentTimelineCellCreateAttributes.md @@ -36,12 +36,11 @@ DatadogAPIClient::V2::IncidentTimelineCellCreateAttributes.build(data_that_doesn #### Parameters -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| -------- | --------- | -------------------------------------------------- | | **data** | **Mixed** | data to be matched against the list of oneOf items | #### Return type - `IncidentTimelineCellMarkdownCreateAttributes` - `nil` (if no type matches) - diff --git a/docs/v2/IncidentTimelineCellMarkdownContentType.md b/docs/v2/IncidentTimelineCellMarkdownContentType.md index 250a4843db90..84ce9f0c91bd 100644 --- a/docs/v2/IncidentTimelineCellMarkdownContentType.md +++ b/docs/v2/IncidentTimelineCellMarkdownContentType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::IncidentTimelineCellMarkdownContentType.new() ``` - diff --git a/docs/v2/IncidentTimelineCellMarkdownCreateAttributes.md b/docs/v2/IncidentTimelineCellMarkdownCreateAttributes.md index 57121e348b34..86b7e5877d63 100644 --- a/docs/v2/IncidentTimelineCellMarkdownCreateAttributes.md +++ b/docs/v2/IncidentTimelineCellMarkdownCreateAttributes.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **cell_type** | [**IncidentTimelineCellMarkdownContentType**](IncidentTimelineCellMarkdownContentType.md) | | [default to 'markdown'] | -| **content** | [**IncidentTimelineCellMarkdownCreateAttributesContent**](IncidentTimelineCellMarkdownCreateAttributesContent.md) | | | -| **important** | **Boolean** | A flag indicating whether the timeline cell is important and should be highlighted. | [optional][default to false] | +| Name | Type | Description | Notes | +| ------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ------------------------------- | +| **cell_type** | [**IncidentTimelineCellMarkdownContentType**](IncidentTimelineCellMarkdownContentType.md) | | [default to 'markdown'] | +| **content** | [**IncidentTimelineCellMarkdownCreateAttributesContent**](IncidentTimelineCellMarkdownCreateAttributesContent.md) | | | +| **important** | **Boolean** | A flag indicating whether the timeline cell is important and should be highlighted. | [optional][default to false] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V2::IncidentTimelineCellMarkdownCreateAttributes.ne important: false ) ``` - diff --git a/docs/v2/IncidentTimelineCellMarkdownCreateAttributesContent.md b/docs/v2/IncidentTimelineCellMarkdownCreateAttributesContent.md index 27c9e4a74c67..ad46af9b2149 100644 --- a/docs/v2/IncidentTimelineCellMarkdownCreateAttributesContent.md +++ b/docs/v2/IncidentTimelineCellMarkdownCreateAttributesContent.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| ----------- | ---------- | --------------------------------- | ---------- | | **content** | **String** | The Markdown content of the cell. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::IncidentTimelineCellMarkdownCreateAttributesCon content: An example timeline cell message. ) ``` - diff --git a/docs/v2/IncidentType.md b/docs/v2/IncidentType.md index ce5e41f35310..e4dc58c94a2f 100644 --- a/docs/v2/IncidentType.md +++ b/docs/v2/IncidentType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::IncidentType.new() ``` - diff --git a/docs/v2/IncidentUpdateAttributes.md b/docs/v2/IncidentUpdateAttributes.md index 5cd40ec5f810..62a4e55c8d98 100644 --- a/docs/v2/IncidentUpdateAttributes.md +++ b/docs/v2/IncidentUpdateAttributes.md @@ -2,17 +2,17 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **customer_impact_end** | **Time** | Timestamp when customers were no longer impacted by the incident. | [optional] | -| **customer_impact_scope** | **String** | A summary of the impact customers experienced during the incident. | [optional] | -| **customer_impact_start** | **Time** | Timestamp when customers began being impacted by the incident. | [optional] | -| **customer_impacted** | **Boolean** | A flag indicating whether the incident caused customer impact. | [optional] | -| **detected** | **Time** | Timestamp when the incident was detected. | [optional] | -| **fields** | [**Hash<String, IncidentFieldAttributes>**](IncidentFieldAttributes.md) | A condensed view of the user-defined fields for which to update selections. | [optional] | -| **notification_handles** | [**Array<IncidentNotificationHandle>**](IncidentNotificationHandle.md) | Notification handles that will be notified of the incident during update. | [optional] | -| **resolved** | **Time** | Timestamp when the incident's state was set to resolved. | [optional] | -| **title** | **String** | The title of the incident, which summarizes what happened. | [optional] | +| Name | Type | Description | Notes | +| ------------------------- | ----------------------------------------------------------------------------- | --------------------------------------------------------------------------- | ---------- | +| **customer_impact_end** | **Time** | Timestamp when customers were no longer impacted by the incident. | [optional] | +| **customer_impact_scope** | **String** | A summary of the impact customers experienced during the incident. | [optional] | +| **customer_impact_start** | **Time** | Timestamp when customers began being impacted by the incident. | [optional] | +| **customer_impacted** | **Boolean** | A flag indicating whether the incident caused customer impact. | [optional] | +| **detected** | **Time** | Timestamp when the incident was detected. | [optional] | +| **fields** | [**Hash<String, IncidentFieldAttributes>**](IncidentFieldAttributes.md) | A condensed view of the user-defined fields for which to update selections. | [optional] | +| **notification_handles** | [**Array<IncidentNotificationHandle>**](IncidentNotificationHandle.md) | Notification handles that will be notified of the incident during update. | [optional] | +| **resolved** | **Time** | Timestamp when the incident's state was set to resolved. | [optional] | +| **title** | **String** | The title of the incident, which summarizes what happened. | [optional] | ## Example @@ -31,4 +31,3 @@ instance = DatadogAPIClient::V2::IncidentUpdateAttributes.new( title: A test incident title ) ``` - diff --git a/docs/v2/IncidentUpdateData.md b/docs/v2/IncidentUpdateData.md index a0732a42e5a7..b0c8544c68bc 100644 --- a/docs/v2/IncidentUpdateData.md +++ b/docs/v2/IncidentUpdateData.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**IncidentUpdateAttributes**](IncidentUpdateAttributes.md) | | [optional] | -| **id** | **String** | The team's ID. | | -| **relationships** | [**IncidentUpdateRelationships**](IncidentUpdateRelationships.md) | | [optional] | -| **type** | [**IncidentType**](IncidentType.md) | | [default to 'incidents'] | +| Name | Type | Description | Notes | +| ----------------- | ----------------------------------------------------------------- | ------------------ | -------------------------------- | +| **attributes** | [**IncidentUpdateAttributes**](IncidentUpdateAttributes.md) | | [optional] | +| **id** | **String** | The team's ID. | | +| **relationships** | [**IncidentUpdateRelationships**](IncidentUpdateRelationships.md) | | [optional] | +| **type** | [**IncidentType**](IncidentType.md) | | [default to 'incidents'] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V2::IncidentUpdateData.new( type: null ) ``` - diff --git a/docs/v2/IncidentUpdateRelationships.md b/docs/v2/IncidentUpdateRelationships.md index b5a3f823a72a..fedcb8cd5838 100644 --- a/docs/v2/IncidentUpdateRelationships.md +++ b/docs/v2/IncidentUpdateRelationships.md @@ -2,13 +2,13 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **commander_user** | [**RelationshipToUser**](RelationshipToUser.md) | | [optional] | -| **created_by_user** | [**RelationshipToUser**](RelationshipToUser.md) | | [optional] | -| **integrations** | [**RelationshipToIncidentIntegrationMetadatas**](RelationshipToIncidentIntegrationMetadatas.md) | | [optional] | -| **last_modified_by_user** | [**RelationshipToUser**](RelationshipToUser.md) | | [optional] | -| **postmortem** | [**RelationshipToIncidentPostmortem**](RelationshipToIncidentPostmortem.md) | | [optional] | +| Name | Type | Description | Notes | +| ------------------------- | ----------------------------------------------------------------------------------------------- | ----------- | ---------- | +| **commander_user** | [**RelationshipToUser**](RelationshipToUser.md) | | [optional] | +| **created_by_user** | [**RelationshipToUser**](RelationshipToUser.md) | | [optional] | +| **integrations** | [**RelationshipToIncidentIntegrationMetadatas**](RelationshipToIncidentIntegrationMetadatas.md) | | [optional] | +| **last_modified_by_user** | [**RelationshipToUser**](RelationshipToUser.md) | | [optional] | +| **postmortem** | [**RelationshipToIncidentPostmortem**](RelationshipToIncidentPostmortem.md) | | [optional] | ## Example @@ -23,4 +23,3 @@ instance = DatadogAPIClient::V2::IncidentUpdateRelationships.new( postmortem: null ) ``` - diff --git a/docs/v2/IncidentUpdateRequest.md b/docs/v2/IncidentUpdateRequest.md index 3e1ec5d1d361..0f4ef1356985 100644 --- a/docs/v2/IncidentUpdateRequest.md +++ b/docs/v2/IncidentUpdateRequest.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**IncidentUpdateData**](IncidentUpdateData.md) | | | +| Name | Type | Description | Notes | +| -------- | ----------------------------------------------- | ----------- | ----- | +| **data** | [**IncidentUpdateData**](IncidentUpdateData.md) | | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::IncidentUpdateRequest.new( data: null ) ``` - diff --git a/docs/v2/IncidentsAPI.md b/docs/v2/IncidentsAPI.md index 7e8871a6f051..3313ad7bc113 100644 --- a/docs/v2/IncidentsAPI.md +++ b/docs/v2/IncidentsAPI.md @@ -2,14 +2,13 @@ All URIs are relative to *https://api.datadoghq.com* -| Method | HTTP request | Description | -| ------ | ------------ | ----------- | -| [**create_incident**](IncidentsAPI.md#create_incident) | **POST** /api/v2/incidents | Create an incident | -| [**delete_incident**](IncidentsAPI.md#delete_incident) | **DELETE** /api/v2/incidents/{incident_id} | Delete an existing incident | -| [**get_incident**](IncidentsAPI.md#get_incident) | **GET** /api/v2/incidents/{incident_id} | Get the details of an incident | -| [**list_incidents**](IncidentsAPI.md#list_incidents) | **GET** /api/v2/incidents | Get a list of incidents | -| [**update_incident**](IncidentsAPI.md#update_incident) | **PATCH** /api/v2/incidents/{incident_id} | Update an existing incident | - +| Method | HTTP request | Description | +| ------------------------------------------------------ | ------------------------------------------ | ------------------------------ | +| [**create_incident**](IncidentsAPI.md#create_incident) | **POST** /api/v2/incidents | Create an incident | +| [**delete_incident**](IncidentsAPI.md#delete_incident) | **DELETE** /api/v2/incidents/{incident_id} | Delete an existing incident | +| [**get_incident**](IncidentsAPI.md#get_incident) | **GET** /api/v2/incidents/{incident_id} | Get the details of an incident | +| [**list_incidents**](IncidentsAPI.md#list_incidents) | **GET** /api/v2/incidents | Get a list of incidents | +| [**update_incident**](IncidentsAPI.md#update_incident) | **PATCH** /api/v2/incidents/{incident_id} | Update an existing incident | ## create_incident @@ -58,9 +57,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**IncidentCreateRequest**](IncidentCreateRequest.md) | Incident payload. | | +| Name | Type | Description | Notes | +| -------- | ----------------------------------------------------- | ----------------- | ----- | +| **body** | [**IncidentCreateRequest**](IncidentCreateRequest.md) | Incident payload. | | ### Return type @@ -75,7 +74,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## delete_incident > delete_incident(incident_id) @@ -122,9 +120,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **incident_id** | **String** | The UUID the incident. | | +| Name | Type | Description | Notes | +| --------------- | ---------- | ---------------------- | ----- | +| **incident_id** | **String** | The UUID the incident. | | ### Return type @@ -139,7 +137,6 @@ nil (empty response body) - **Content-Type**: Not defined - **Accept**: application/json - ## get_incident > get_incident(incident_id, opts) @@ -190,10 +187,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **incident_id** | **String** | The UUID the incident. | | -| **include** | **Array<IncidentRelatedObject>** | Specifies which types of related objects should be included in the response. | [optional] | +| Name | Type | Description | Notes | +| --------------- | -------------------------------------- | ---------------------------------------------------------------------------- | ---------- | +| **incident_id** | **String** | The UUID the incident. | | +| **include** | **Array<IncidentRelatedObject>** | Specifies which types of related objects should be included in the response. | [optional] | ### Return type @@ -208,7 +205,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## list_incidents > list_incidents(opts) @@ -260,11 +256,11 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **include** | **Array<IncidentRelatedObject>** | Specifies which types of related objects should be included in the response. | [optional] | -| **page_size** | **Integer** | Size for a given page. | [optional][default to 10] | -| **page_offset** | **Integer** | Specific offset to use as the beginning of the returned page. | [optional][default to 0] | +| Name | Type | Description | Notes | +| --------------- | -------------------------------------- | ---------------------------------------------------------------------------- | ------------------------- | +| **include** | **Array<IncidentRelatedObject>** | Specifies which types of related objects should be included in the response. | [optional] | +| **page_size** | **Integer** | Size for a given page. | [optional][default to 10] | +| **page_offset** | **Integer** | Specific offset to use as the beginning of the returned page. | [optional][default to 0] | ### Return type @@ -279,7 +275,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## update_incident > update_incident(incident_id, body) @@ -328,10 +323,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **incident_id** | **String** | The UUID the incident. | | -| **body** | [**IncidentUpdateRequest**](IncidentUpdateRequest.md) | Incident Payload. | | +| Name | Type | Description | Notes | +| --------------- | ----------------------------------------------------- | ---------------------- | ----- | +| **incident_id** | **String** | The UUID the incident. | | +| **body** | [**IncidentUpdateRequest**](IncidentUpdateRequest.md) | Incident Payload. | | ### Return type @@ -345,4 +340,3 @@ end - **Content-Type**: application/json - **Accept**: application/json - diff --git a/docs/v2/IncidentsResponse.md b/docs/v2/IncidentsResponse.md index 3cd461cd06a8..92022daa7ca0 100644 --- a/docs/v2/IncidentsResponse.md +++ b/docs/v2/IncidentsResponse.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**Array<IncidentResponseData>**](IncidentResponseData.md) | An array of incidents. | | +| Name | Type | Description | Notes | +| ------------ | -------------------------------------------------------------------------------- | --------------------------------------------------- | -------------------- | +| **data** | [**Array<IncidentResponseData>**](IncidentResponseData.md) | An array of incidents. | | | **included** | [**Array<IncidentResponseIncludedItem>**](IncidentResponseIncludedItem.md) | Included related resources that the user requested. | [optional][readonly] | -| **meta** | [**IncidentServicesResponseMeta**](IncidentServicesResponseMeta.md) | | [optional] | +| **meta** | [**IncidentServicesResponseMeta**](IncidentServicesResponseMeta.md) | | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V2::IncidentsResponse.new( meta: null ) ``` - diff --git a/docs/v2/KeyManagementAPI.md b/docs/v2/KeyManagementAPI.md index cf4ad536a893..c4c7930e047b 100644 --- a/docs/v2/KeyManagementAPI.md +++ b/docs/v2/KeyManagementAPI.md @@ -2,23 +2,22 @@ All URIs are relative to *https://api.datadoghq.com* -| Method | HTTP request | Description | -| ------ | ------------ | ----------- | -| [**create_api_key**](KeyManagementAPI.md#create_api_key) | **POST** /api/v2/api_keys | Create an API key | -| [**create_current_user_application_key**](KeyManagementAPI.md#create_current_user_application_key) | **POST** /api/v2/current_user/application_keys | Create an application key for current user | -| [**delete_api_key**](KeyManagementAPI.md#delete_api_key) | **DELETE** /api/v2/api_keys/{api_key_id} | Delete an API key | -| [**delete_application_key**](KeyManagementAPI.md#delete_application_key) | **DELETE** /api/v2/application_keys/{app_key_id} | Delete an application key | +| Method | HTTP request | Description | +| -------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- | ----------------------------------------------- | +| [**create_api_key**](KeyManagementAPI.md#create_api_key) | **POST** /api/v2/api_keys | Create an API key | +| [**create_current_user_application_key**](KeyManagementAPI.md#create_current_user_application_key) | **POST** /api/v2/current_user/application_keys | Create an application key for current user | +| [**delete_api_key**](KeyManagementAPI.md#delete_api_key) | **DELETE** /api/v2/api_keys/{api_key_id} | Delete an API key | +| [**delete_application_key**](KeyManagementAPI.md#delete_application_key) | **DELETE** /api/v2/application_keys/{app_key_id} | Delete an application key | | [**delete_current_user_application_key**](KeyManagementAPI.md#delete_current_user_application_key) | **DELETE** /api/v2/current_user/application_keys/{app_key_id} | Delete an application key owned by current user | -| [**get_api_key**](KeyManagementAPI.md#get_api_key) | **GET** /api/v2/api_keys/{api_key_id} | Get API key | -| [**get_application_key**](KeyManagementAPI.md#get_application_key) | **GET** /api/v2/application_keys/{app_key_id} | Get an application key | -| [**get_current_user_application_key**](KeyManagementAPI.md#get_current_user_application_key) | **GET** /api/v2/current_user/application_keys/{app_key_id} | Get one application key owned by current user | -| [**list_api_keys**](KeyManagementAPI.md#list_api_keys) | **GET** /api/v2/api_keys | Get all API keys | -| [**list_application_keys**](KeyManagementAPI.md#list_application_keys) | **GET** /api/v2/application_keys | Get all application keys | -| [**list_current_user_application_keys**](KeyManagementAPI.md#list_current_user_application_keys) | **GET** /api/v2/current_user/application_keys | Get all application keys owned by current user | -| [**update_api_key**](KeyManagementAPI.md#update_api_key) | **PATCH** /api/v2/api_keys/{api_key_id} | Edit an API key | -| [**update_application_key**](KeyManagementAPI.md#update_application_key) | **PATCH** /api/v2/application_keys/{app_key_id} | Edit an application key | -| [**update_current_user_application_key**](KeyManagementAPI.md#update_current_user_application_key) | **PATCH** /api/v2/current_user/application_keys/{app_key_id} | Edit an application key owned by current user | - +| [**get_api_key**](KeyManagementAPI.md#get_api_key) | **GET** /api/v2/api_keys/{api_key_id} | Get API key | +| [**get_application_key**](KeyManagementAPI.md#get_application_key) | **GET** /api/v2/application_keys/{app_key_id} | Get an application key | +| [**get_current_user_application_key**](KeyManagementAPI.md#get_current_user_application_key) | **GET** /api/v2/current_user/application_keys/{app_key_id} | Get one application key owned by current user | +| [**list_api_keys**](KeyManagementAPI.md#list_api_keys) | **GET** /api/v2/api_keys | Get all API keys | +| [**list_application_keys**](KeyManagementAPI.md#list_application_keys) | **GET** /api/v2/application_keys | Get all application keys | +| [**list_current_user_application_keys**](KeyManagementAPI.md#list_current_user_application_keys) | **GET** /api/v2/current_user/application_keys | Get all application keys owned by current user | +| [**update_api_key**](KeyManagementAPI.md#update_api_key) | **PATCH** /api/v2/api_keys/{api_key_id} | Edit an API key | +| [**update_application_key**](KeyManagementAPI.md#update_application_key) | **PATCH** /api/v2/application_keys/{app_key_id} | Edit an application key | +| [**update_current_user_application_key**](KeyManagementAPI.md#update_current_user_application_key) | **PATCH** /api/v2/current_user/application_keys/{app_key_id} | Edit an application key owned by current user | ## create_api_key @@ -31,7 +30,7 @@ Create an API key. ```ruby require 'datadog_api_client' api_instance = DatadogAPIClient::V2::KeyManagementAPI.new -body = DatadogAPIClient::V2::APIKeyCreateRequest.new({data: DatadogAPIClient::V2::APIKeyCreateData.new({attributes: DatadogAPIClient::V2::APIKeyCreateAttributes.new({name: 'API Key for submitting metrics'}), type: DatadogAPIClient::V2::APIKeysType::API_KEYS})}) # APIKeyCreateRequest | +body = DatadogAPIClient::V2::APIKeyCreateRequest.new({data: DatadogAPIClient::V2::APIKeyCreateData.new({attributes: DatadogAPIClient::V2::APIKeyCreateAttributes.new({name: 'API Key for submitting metrics'}), type: DatadogAPIClient::V2::APIKeysType::API_KEYS})}) # APIKeyCreateRequest | begin # Create an API key @@ -62,9 +61,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**APIKeyCreateRequest**](APIKeyCreateRequest.md) | | | +| Name | Type | Description | Notes | +| -------- | ------------------------------------------------- | ----------- | ----- | +| **body** | [**APIKeyCreateRequest**](APIKeyCreateRequest.md) | | | ### Return type @@ -79,7 +78,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## create_current_user_application_key > create_current_user_application_key(body) @@ -91,7 +89,7 @@ Create an application key for current user ```ruby require 'datadog_api_client' api_instance = DatadogAPIClient::V2::KeyManagementAPI.new -body = DatadogAPIClient::V2::ApplicationKeyCreateRequest.new({data: DatadogAPIClient::V2::ApplicationKeyCreateData.new({attributes: DatadogAPIClient::V2::ApplicationKeyCreateAttributes.new({name: 'Application Key for submitting metrics'}), type: DatadogAPIClient::V2::ApplicationKeysType::APPLICATION_KEYS})}) # ApplicationKeyCreateRequest | +body = DatadogAPIClient::V2::ApplicationKeyCreateRequest.new({data: DatadogAPIClient::V2::ApplicationKeyCreateData.new({attributes: DatadogAPIClient::V2::ApplicationKeyCreateAttributes.new({name: 'Application Key for submitting metrics'}), type: DatadogAPIClient::V2::ApplicationKeysType::APPLICATION_KEYS})}) # ApplicationKeyCreateRequest | begin # Create an application key for current user @@ -122,9 +120,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**ApplicationKeyCreateRequest**](ApplicationKeyCreateRequest.md) | | | +| Name | Type | Description | Notes | +| -------- | ----------------------------------------------------------------- | ----------- | ----- | +| **body** | [**ApplicationKeyCreateRequest**](ApplicationKeyCreateRequest.md) | | | ### Return type @@ -139,7 +137,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## delete_api_key > delete_api_key(api_key_id) @@ -181,9 +178,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **api_key_id** | **String** | The ID of the API key. | | +| Name | Type | Description | Notes | +| -------------- | ---------- | ---------------------- | ----- | +| **api_key_id** | **String** | The ID of the API key. | | ### Return type @@ -198,7 +195,6 @@ nil (empty response body) - **Content-Type**: Not defined - **Accept**: application/json - ## delete_application_key > delete_application_key(app_key_id) @@ -240,9 +236,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **app_key_id** | **String** | The ID of the application key. | | +| Name | Type | Description | Notes | +| -------------- | ---------- | ------------------------------ | ----- | +| **app_key_id** | **String** | The ID of the application key. | | ### Return type @@ -257,7 +253,6 @@ nil (empty response body) - **Content-Type**: Not defined - **Accept**: application/json - ## delete_current_user_application_key > delete_current_user_application_key(app_key_id) @@ -299,9 +294,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **app_key_id** | **String** | The ID of the application key. | | +| Name | Type | Description | Notes | +| -------------- | ---------- | ------------------------------ | ----- | +| **app_key_id** | **String** | The ID of the application key. | | ### Return type @@ -316,7 +311,6 @@ nil (empty response body) - **Content-Type**: Not defined - **Accept**: application/json - ## get_api_key > get_api_key(api_key_id, opts) @@ -362,10 +356,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **api_key_id** | **String** | The ID of the API key. | | -| **include** | **String** | Comma separated list of resource paths for related resources to include in the response. Supported resource paths are `created_by` and `modified_by`. | [optional] | +| Name | Type | Description | Notes | +| -------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **api_key_id** | **String** | The ID of the API key. | | +| **include** | **String** | Comma separated list of resource paths for related resources to include in the response. Supported resource paths are `created_by` and `modified_by`. | [optional] | ### Return type @@ -380,7 +374,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## get_application_key > get_application_key(app_key_id, opts) @@ -426,10 +419,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **app_key_id** | **String** | The ID of the application key. | | -| **include** | **String** | Resource path for related resources to include in the response. Only `owned_by` is supported. | [optional] | +| Name | Type | Description | Notes | +| -------------- | ---------- | ------------------------------------------------------------------------------------------------------- | ---------- | +| **app_key_id** | **String** | The ID of the application key. | | +| **include** | **String** | Resource path for related resources to include in the response. Only `owned_by` is supported. | [optional] | ### Return type @@ -444,7 +437,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## get_current_user_application_key > get_current_user_application_key(app_key_id) @@ -487,9 +479,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **app_key_id** | **String** | The ID of the application key. | | +| Name | Type | Description | Notes | +| -------------- | ---------- | ------------------------------ | ----- | +| **app_key_id** | **String** | The ID of the application key. | | ### Return type @@ -504,7 +496,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## list_api_keys > list_api_keys(opts) @@ -557,17 +548,17 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **page_size** | **Integer** | Size for a given page. | [optional][default to 10] | -| **page_number** | **Integer** | Specific page number to return. | [optional][default to 0] | -| **sort** | **APIKeysSort** | API key attribute used to sort results. Sort order is ascending by default. In order to specify a descending sort, prefix the attribute with a minus sign. | [optional][default to 'name'] | -| **filter** | **String** | Filter API keys by the specified string. | [optional] | -| **filter_created_at_start** | **String** | Only include API keys created on or after the specified date. | [optional] | -| **filter_created_at_end** | **String** | Only include API keys created on or before the specified date. | [optional] | -| **filter_modified_at_start** | **String** | Only include API keys modified on or after the specified date. | [optional] | -| **filter_modified_at_end** | **String** | Only include API keys modified on or before the specified date. | [optional] | -| **include** | **String** | Comma separated list of resource paths for related resources to include in the response. Supported resource paths are `created_by` and `modified_by`. | [optional] | +| Name | Type | Description | Notes | +| ---------------------------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | +| **page_size** | **Integer** | Size for a given page. | [optional][default to 10] | +| **page_number** | **Integer** | Specific page number to return. | [optional][default to 0] | +| **sort** | **APIKeysSort** | API key attribute used to sort results. Sort order is ascending by default. In order to specify a descending sort, prefix the attribute with a minus sign. | [optional][default to 'name'] | +| **filter** | **String** | Filter API keys by the specified string. | [optional] | +| **filter_created_at_start** | **String** | Only include API keys created on or after the specified date. | [optional] | +| **filter_created_at_end** | **String** | Only include API keys created on or before the specified date. | [optional] | +| **filter_modified_at_start** | **String** | Only include API keys modified on or after the specified date. | [optional] | +| **filter_modified_at_end** | **String** | Only include API keys modified on or before the specified date. | [optional] | +| **include** | **String** | Comma separated list of resource paths for related resources to include in the response. Supported resource paths are `created_by` and `modified_by`. | [optional] | ### Return type @@ -582,7 +573,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## list_application_keys > list_application_keys(opts) @@ -632,14 +622,14 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **page_size** | **Integer** | Size for a given page. | [optional][default to 10] | -| **page_number** | **Integer** | Specific page number to return. | [optional][default to 0] | -| **sort** | **ApplicationKeysSort** | Application key attribute used to sort results. Sort order is ascending by default. In order to specify a descending sort, prefix the attribute with a minus sign. | [optional][default to 'name'] | -| **filter** | **String** | Filter application keys by the specified string. | [optional] | -| **filter_created_at_start** | **String** | Only include application keys created on or after the specified date. | [optional] | -| **filter_created_at_end** | **String** | Only include application keys created on or before the specified date. | [optional] | +| Name | Type | Description | Notes | +| --------------------------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------- | +| **page_size** | **Integer** | Size for a given page. | [optional][default to 10] | +| **page_number** | **Integer** | Specific page number to return. | [optional][default to 0] | +| **sort** | **ApplicationKeysSort** | Application key attribute used to sort results. Sort order is ascending by default. In order to specify a descending sort, prefix the attribute with a minus sign. | [optional][default to 'name'] | +| **filter** | **String** | Filter application keys by the specified string. | [optional] | +| **filter_created_at_start** | **String** | Only include application keys created on or after the specified date. | [optional] | +| **filter_created_at_end** | **String** | Only include application keys created on or before the specified date. | [optional] | ### Return type @@ -654,7 +644,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## list_current_user_application_keys > list_current_user_application_keys(opts) @@ -704,14 +693,14 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **page_size** | **Integer** | Size for a given page. | [optional][default to 10] | -| **page_number** | **Integer** | Specific page number to return. | [optional][default to 0] | -| **sort** | **ApplicationKeysSort** | Application key attribute used to sort results. Sort order is ascending by default. In order to specify a descending sort, prefix the attribute with a minus sign. | [optional][default to 'name'] | -| **filter** | **String** | Filter application keys by the specified string. | [optional] | -| **filter_created_at_start** | **String** | Only include application keys created on or after the specified date. | [optional] | -| **filter_created_at_end** | **String** | Only include application keys created on or before the specified date. | [optional] | +| Name | Type | Description | Notes | +| --------------------------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------- | +| **page_size** | **Integer** | Size for a given page. | [optional][default to 10] | +| **page_number** | **Integer** | Specific page number to return. | [optional][default to 0] | +| **sort** | **ApplicationKeysSort** | Application key attribute used to sort results. Sort order is ascending by default. In order to specify a descending sort, prefix the attribute with a minus sign. | [optional][default to 'name'] | +| **filter** | **String** | Filter application keys by the specified string. | [optional] | +| **filter_created_at_start** | **String** | Only include application keys created on or after the specified date. | [optional] | +| **filter_created_at_end** | **String** | Only include application keys created on or before the specified date. | [optional] | ### Return type @@ -726,7 +715,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## update_api_key > update_api_key(api_key_id, body) @@ -739,7 +727,7 @@ Update an API key. require 'datadog_api_client' api_instance = DatadogAPIClient::V2::KeyManagementAPI.new api_key_id = 'api_key_id_example' # String | The ID of the API key. -body = DatadogAPIClient::V2::APIKeyUpdateRequest.new({data: DatadogAPIClient::V2::APIKeyUpdateData.new({attributes: DatadogAPIClient::V2::APIKeyUpdateAttributes.new({name: 'API Key for submitting metrics'}), id: '00112233-4455-6677-8899-aabbccddeeff', type: DatadogAPIClient::V2::APIKeysType::API_KEYS})}) # APIKeyUpdateRequest | +body = DatadogAPIClient::V2::APIKeyUpdateRequest.new({data: DatadogAPIClient::V2::APIKeyUpdateData.new({attributes: DatadogAPIClient::V2::APIKeyUpdateAttributes.new({name: 'API Key for submitting metrics'}), id: '00112233-4455-6677-8899-aabbccddeeff', type: DatadogAPIClient::V2::APIKeysType::API_KEYS})}) # APIKeyUpdateRequest | begin # Edit an API key @@ -770,10 +758,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **api_key_id** | **String** | The ID of the API key. | | -| **body** | [**APIKeyUpdateRequest**](APIKeyUpdateRequest.md) | | | +| Name | Type | Description | Notes | +| -------------- | ------------------------------------------------- | ---------------------- | ----- | +| **api_key_id** | **String** | The ID of the API key. | | +| **body** | [**APIKeyUpdateRequest**](APIKeyUpdateRequest.md) | | | ### Return type @@ -788,7 +776,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## update_application_key > update_application_key(app_key_id, body) @@ -801,7 +788,7 @@ Edit an application key require 'datadog_api_client' api_instance = DatadogAPIClient::V2::KeyManagementAPI.new app_key_id = 'app_key_id_example' # String | The ID of the application key. -body = DatadogAPIClient::V2::ApplicationKeyUpdateRequest.new({data: DatadogAPIClient::V2::ApplicationKeyUpdateData.new({attributes: DatadogAPIClient::V2::ApplicationKeyUpdateAttributes.new({name: 'Application Key for submitting metrics'}), id: '00112233-4455-6677-8899-aabbccddeeff', type: DatadogAPIClient::V2::ApplicationKeysType::APPLICATION_KEYS})}) # ApplicationKeyUpdateRequest | +body = DatadogAPIClient::V2::ApplicationKeyUpdateRequest.new({data: DatadogAPIClient::V2::ApplicationKeyUpdateData.new({attributes: DatadogAPIClient::V2::ApplicationKeyUpdateAttributes.new({name: 'Application Key for submitting metrics'}), id: '00112233-4455-6677-8899-aabbccddeeff', type: DatadogAPIClient::V2::ApplicationKeysType::APPLICATION_KEYS})}) # ApplicationKeyUpdateRequest | begin # Edit an application key @@ -832,10 +819,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **app_key_id** | **String** | The ID of the application key. | | -| **body** | [**ApplicationKeyUpdateRequest**](ApplicationKeyUpdateRequest.md) | | | +| Name | Type | Description | Notes | +| -------------- | ----------------------------------------------------------------- | ------------------------------ | ----- | +| **app_key_id** | **String** | The ID of the application key. | | +| **body** | [**ApplicationKeyUpdateRequest**](ApplicationKeyUpdateRequest.md) | | | ### Return type @@ -850,7 +837,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## update_current_user_application_key > update_current_user_application_key(app_key_id, body) @@ -863,7 +849,7 @@ Edit an application key owned by current user require 'datadog_api_client' api_instance = DatadogAPIClient::V2::KeyManagementAPI.new app_key_id = 'app_key_id_example' # String | The ID of the application key. -body = DatadogAPIClient::V2::ApplicationKeyUpdateRequest.new({data: DatadogAPIClient::V2::ApplicationKeyUpdateData.new({attributes: DatadogAPIClient::V2::ApplicationKeyUpdateAttributes.new({name: 'Application Key for submitting metrics'}), id: '00112233-4455-6677-8899-aabbccddeeff', type: DatadogAPIClient::V2::ApplicationKeysType::APPLICATION_KEYS})}) # ApplicationKeyUpdateRequest | +body = DatadogAPIClient::V2::ApplicationKeyUpdateRequest.new({data: DatadogAPIClient::V2::ApplicationKeyUpdateData.new({attributes: DatadogAPIClient::V2::ApplicationKeyUpdateAttributes.new({name: 'Application Key for submitting metrics'}), id: '00112233-4455-6677-8899-aabbccddeeff', type: DatadogAPIClient::V2::ApplicationKeysType::APPLICATION_KEYS})}) # ApplicationKeyUpdateRequest | begin # Edit an application key owned by current user @@ -894,10 +880,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **app_key_id** | **String** | The ID of the application key. | | -| **body** | [**ApplicationKeyUpdateRequest**](ApplicationKeyUpdateRequest.md) | | | +| Name | Type | Description | Notes | +| -------------- | ----------------------------------------------------------------- | ------------------------------ | ----- | +| **app_key_id** | **String** | The ID of the application key. | | +| **body** | [**ApplicationKeyUpdateRequest**](ApplicationKeyUpdateRequest.md) | | | ### Return type @@ -911,4 +897,3 @@ end - **Content-Type**: application/json - **Accept**: application/json - diff --git a/docs/v2/ListApplicationKeysResponse.md b/docs/v2/ListApplicationKeysResponse.md index 5b470e0c7827..04ada87e43a9 100644 --- a/docs/v2/ListApplicationKeysResponse.md +++ b/docs/v2/ListApplicationKeysResponse.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**Array<PartialApplicationKey>**](PartialApplicationKey.md) | Array of application keys. | [optional] | +| Name | Type | Description | Notes | +| ------------ | -------------------------------------------------------------------------------------------- | ------------------------------------------------ | ---------- | +| **data** | [**Array<PartialApplicationKey>**](PartialApplicationKey.md) | Array of application keys. | [optional] | | **included** | [**Array<ApplicationKeyResponseIncludedItem>**](ApplicationKeyResponseIncludedItem.md) | Array of objects related to the application key. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::ListApplicationKeysResponse.new( included: null ) ``` - diff --git a/docs/v2/Log.md b/docs/v2/Log.md index 405d31318fd6..82100290919b 100644 --- a/docs/v2/Log.md +++ b/docs/v2/Log.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**LogAttributes**](LogAttributes.md) | | [optional] | -| **id** | **String** | Unique ID of the Log. | [optional] | -| **type** | [**LogType**](LogType.md) | | [optional][default to 'log'] | +| Name | Type | Description | Notes | +| -------------- | ------------------------------------- | --------------------- | ------------------------------------ | +| **attributes** | [**LogAttributes**](LogAttributes.md) | | [optional] | +| **id** | **String** | Unique ID of the Log. | [optional] | +| **type** | [**LogType**](LogType.md) | | [optional][default to 'log'] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V2::Log.new( type: null ) ``` - diff --git a/docs/v2/LogAttributes.md b/docs/v2/LogAttributes.md index e3703f0a6459..f09613f4e1a9 100644 --- a/docs/v2/LogAttributes.md +++ b/docs/v2/LogAttributes.md @@ -2,15 +2,15 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | **Hash<String, Object>** | JSON object of attributes from your log. | [optional] | -| **host** | **String** | Name of the machine from where the logs are being sent. | [optional] | -| **message** | **String** | The message [reserved attribute](https://docs.datadoghq.com/logs/log_collection/#reserved-attributes) of your log. By default, Datadog ingests the value of the message attribute as the body of the log entry. That value is then highlighted and displayed in the Logstream, where it is indexed for full text search. | [optional] | -| **service** | **String** | The name of the application or service generating the log events. It is used to switch from Logs to APM, so make sure you define the same value when you use both products. | [optional] | -| **status** | **String** | Status of the message associated with your log. | [optional] | -| **tags** | **Array<String>** | Array of tags associated with your log. | [optional] | -| **timestamp** | **Time** | Timestamp of your log. | [optional] | +| Name | Type | Description | Notes | +| -------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------- | +| **attributes** | **Hash<String, Object>** | JSON object of attributes from your log. | [optional] | +| **host** | **String** | Name of the machine from where the logs are being sent. | [optional] | +| **message** | **String** | The message [reserved attribute](https://docs.datadoghq.com/logs/log_collection/#reserved-attributes) of your log. By default, Datadog ingests the value of the message attribute as the body of the log entry. That value is then highlighted and displayed in the Logstream, where it is indexed for full text search. | [optional] | +| **service** | **String** | The name of the application or service generating the log events. It is used to switch from Logs to APM, so make sure you define the same value when you use both products. | [optional] | +| **status** | **String** | Status of the message associated with your log. | [optional] | +| **tags** | **Array<String>** | Array of tags associated with your log. | [optional] | +| **timestamp** | **Time** | Timestamp of your log. | [optional] | ## Example @@ -27,4 +27,3 @@ instance = DatadogAPIClient::V2::LogAttributes.new( timestamp: 2019-01-02T09:42:36.320Z ) ``` - diff --git a/docs/v2/LogType.md b/docs/v2/LogType.md index be83ac07af8b..82b7a3e94815 100644 --- a/docs/v2/LogType.md +++ b/docs/v2/LogType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::LogType.new() ``` - diff --git a/docs/v2/LogsAPI.md b/docs/v2/LogsAPI.md index 0fb1785ca784..eb9b82ef11b0 100644 --- a/docs/v2/LogsAPI.md +++ b/docs/v2/LogsAPI.md @@ -2,12 +2,11 @@ All URIs are relative to *https://api.datadoghq.com* -| Method | HTTP request | Description | -| ------ | ------------ | ----------- | -| [**aggregate_logs**](LogsAPI.md#aggregate_logs) | **POST** /api/v2/logs/analytics/aggregate | Aggregate events | -| [**list_logs**](LogsAPI.md#list_logs) | **POST** /api/v2/logs/events/search | Search logs | -| [**list_logs_get**](LogsAPI.md#list_logs_get) | **GET** /api/v2/logs/events | Get a list of logs | - +| Method | HTTP request | Description | +| ----------------------------------------------- | ----------------------------------------- | ------------------ | +| [**aggregate_logs**](LogsAPI.md#aggregate_logs) | **POST** /api/v2/logs/analytics/aggregate | Aggregate events | +| [**list_logs**](LogsAPI.md#list_logs) | **POST** /api/v2/logs/events/search | Search logs | +| [**list_logs_get**](LogsAPI.md#list_logs_get) | **GET** /api/v2/logs/events | Get a list of logs | ## aggregate_logs @@ -20,7 +19,7 @@ The API endpoint to aggregate events into buckets and compute metrics and timese ```ruby require 'datadog_api_client' api_instance = DatadogAPIClient::V2::LogsAPI.new -body = DatadogAPIClient::V2::LogsAggregateRequest.new # LogsAggregateRequest | +body = DatadogAPIClient::V2::LogsAggregateRequest.new # LogsAggregateRequest | begin # Aggregate events @@ -51,9 +50,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**LogsAggregateRequest**](LogsAggregateRequest.md) | | | +| Name | Type | Description | Notes | +| -------- | --------------------------------------------------- | ----------- | ----- | +| **body** | [**LogsAggregateRequest**](LogsAggregateRequest.md) | | | ### Return type @@ -68,7 +67,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## list_logs > list_logs(opts) @@ -91,7 +89,7 @@ See [Datadog Logs Archive documentation][2].** require 'datadog_api_client' api_instance = DatadogAPIClient::V2::LogsAPI.new opts = { - body: DatadogAPIClient::V2::LogsListRequest.new # LogsListRequest | + body: DatadogAPIClient::V2::LogsListRequest.new # LogsListRequest | } begin @@ -123,9 +121,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**LogsListRequest**](LogsListRequest.md) | | [optional] | +| Name | Type | Description | Notes | +| -------- | ----------------------------------------- | ----------- | ---------- | +| **body** | [**LogsListRequest**](LogsListRequest.md) | | [optional] | ### Return type @@ -140,7 +138,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## list_logs_get > list_logs_get(opts) @@ -201,15 +198,15 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **filter_query** | **String** | Search query following logs syntax. | [optional] | -| **filter_index** | **String** | For customers with multiple indexes, the indexes to search Defaults to '*' which means all indexes | [optional] | -| **filter_from** | **Time** | Minimum timestamp for requested logs. | [optional] | -| **filter_to** | **Time** | Maximum timestamp for requested logs. | [optional] | -| **sort** | **LogsSort** | Order of logs in results. | [optional] | -| **page_cursor** | **String** | List following results with a cursor provided in the previous query. | [optional] | -| **page_limit** | **Integer** | Maximum number of logs in the response. | [optional][default to 10] | +| Name | Type | Description | Notes | +| ---------------- | ------------ | ----------------------------------------------------------------------------------------------------------- | ------------------------- | +| **filter_query** | **String** | Search query following logs syntax. | [optional] | +| **filter_index** | **String** | For customers with multiple indexes, the indexes to search Defaults to '\*' which means all indexes | [optional] | +| **filter_from** | **Time** | Minimum timestamp for requested logs. | [optional] | +| **filter_to** | **Time** | Maximum timestamp for requested logs. | [optional] | +| **sort** | **LogsSort** | Order of logs in results. | [optional] | +| **page_cursor** | **String** | List following results with a cursor provided in the previous query. | [optional] | +| **page_limit** | **Integer** | Maximum number of logs in the response. | [optional][default to 10] | ### Return type @@ -223,4 +220,3 @@ end - **Content-Type**: Not defined - **Accept**: application/json - diff --git a/docs/v2/LogsAggregateBucket.md b/docs/v2/LogsAggregateBucket.md index dff99b5ece62..713d434b0450 100644 --- a/docs/v2/LogsAggregateBucket.md +++ b/docs/v2/LogsAggregateBucket.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **by** | **Hash<String, String>** | The key, value pairs for each group by | [optional] | +| Name | Type | Description | Notes | +| ------------ | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ---------- | +| **by** | **Hash<String, String>** | The key, value pairs for each group by | [optional] | | **computes** | [**Hash<String, LogsAggregateBucketValue>**](LogsAggregateBucketValue.md) | A map of the metric name -> value for regular compute or list of values for a timeseries | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::LogsAggregateBucket.new( computes: null ) ``` - diff --git a/docs/v2/LogsAggregateBucketValue.md b/docs/v2/LogsAggregateBucketValue.md index 6bda988c1901..68fee324e04f 100644 --- a/docs/v2/LogsAggregateBucketValue.md +++ b/docs/v2/LogsAggregateBucketValue.md @@ -38,8 +38,8 @@ DatadogAPIClient::V2::LogsAggregateBucketValue.build(data_that_doesnt_match) #### Parameters -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| -------- | --------- | -------------------------------------------------- | | **data** | **Mixed** | data to be matched against the list of oneOf items | #### Return type @@ -48,4 +48,3 @@ DatadogAPIClient::V2::LogsAggregateBucketValue.build(data_that_doesnt_match) - `Float` - `String` - `nil` (if no type matches) - diff --git a/docs/v2/LogsAggregateBucketValueTimeseriesPoint.md b/docs/v2/LogsAggregateBucketValueTimeseriesPoint.md index a2aad2c5ee50..b78bbb11932d 100644 --- a/docs/v2/LogsAggregateBucketValueTimeseriesPoint.md +++ b/docs/v2/LogsAggregateBucketValueTimeseriesPoint.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **time** | **String** | The time value for this point | [optional] | -| **value** | **Float** | The value for this point | [optional] | +| Name | Type | Description | Notes | +| --------- | ---------- | ----------------------------- | ---------- | +| **time** | **String** | The time value for this point | [optional] | +| **value** | **Float** | The value for this point | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::LogsAggregateBucketValueTimeseriesPoint.new( value: 19 ) ``` - diff --git a/docs/v2/LogsAggregateRequest.md b/docs/v2/LogsAggregateRequest.md index 1a9e7626ddba..5f15e4118343 100644 --- a/docs/v2/LogsAggregateRequest.md +++ b/docs/v2/LogsAggregateRequest.md @@ -2,13 +2,13 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **compute** | [**Array<LogsCompute>**](LogsCompute.md) | The list of metrics or timeseries to compute for the retrieved buckets. | [optional] | -| **filter** | [**LogsQueryFilter**](LogsQueryFilter.md) | | [optional] | -| **group_by** | [**Array<LogsGroupBy>**](LogsGroupBy.md) | The rules for the group by | [optional] | -| **options** | [**LogsQueryOptions**](LogsQueryOptions.md) | | [optional] | -| **page** | [**LogsAggregateRequestPage**](LogsAggregateRequestPage.md) | | [optional] | +| Name | Type | Description | Notes | +| ------------ | ----------------------------------------------------------- | ----------------------------------------------------------------------- | ---------- | +| **compute** | [**Array<LogsCompute>**](LogsCompute.md) | The list of metrics or timeseries to compute for the retrieved buckets. | [optional] | +| **filter** | [**LogsQueryFilter**](LogsQueryFilter.md) | | [optional] | +| **group_by** | [**Array<LogsGroupBy>**](LogsGroupBy.md) | The rules for the group by | [optional] | +| **options** | [**LogsQueryOptions**](LogsQueryOptions.md) | | [optional] | +| **page** | [**LogsAggregateRequestPage**](LogsAggregateRequestPage.md) | | [optional] | ## Example @@ -23,4 +23,3 @@ instance = DatadogAPIClient::V2::LogsAggregateRequest.new( page: null ) ``` - diff --git a/docs/v2/LogsAggregateRequestPage.md b/docs/v2/LogsAggregateRequestPage.md index 4cb00fde9cba..4ac56cd59951 100644 --- a/docs/v2/LogsAggregateRequestPage.md +++ b/docs/v2/LogsAggregateRequestPage.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| ---------- | ---------- | -------------------------------------------------------- | ---------- | | **cursor** | **String** | The returned paging point to use to get the next results | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::LogsAggregateRequestPage.new( cursor: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== ) ``` - diff --git a/docs/v2/LogsAggregateResponse.md b/docs/v2/LogsAggregateResponse.md index 5c2f6c66aa5a..1a69754edf44 100644 --- a/docs/v2/LogsAggregateResponse.md +++ b/docs/v2/LogsAggregateResponse.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**LogsAggregateResponseData**](LogsAggregateResponseData.md) | | [optional] | -| **meta** | [**LogsResponseMetadata**](LogsResponseMetadata.md) | | [optional] | +| Name | Type | Description | Notes | +| -------- | ------------------------------------------------------------- | ----------- | ---------- | +| **data** | [**LogsAggregateResponseData**](LogsAggregateResponseData.md) | | [optional] | +| **meta** | [**LogsResponseMetadata**](LogsResponseMetadata.md) | | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::LogsAggregateResponse.new( meta: null ) ``` - diff --git a/docs/v2/LogsAggregateResponseData.md b/docs/v2/LogsAggregateResponseData.md index 2e11361afebc..68263048f940 100644 --- a/docs/v2/LogsAggregateResponseData.md +++ b/docs/v2/LogsAggregateResponseData.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| ----------- | -------------------------------------------------------------- | ------------------------------------------------- | ---------- | | **buckets** | [**Array<LogsAggregateBucket>**](LogsAggregateBucket.md) | The list of matching buckets, one item per bucket | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::LogsAggregateResponseData.new( buckets: null ) ``` - diff --git a/docs/v2/LogsAggregateResponseStatus.md b/docs/v2/LogsAggregateResponseStatus.md index e0fbbb9cba78..392e9f326326 100644 --- a/docs/v2/LogsAggregateResponseStatus.md +++ b/docs/v2/LogsAggregateResponseStatus.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::LogsAggregateResponseStatus.new() ``` - diff --git a/docs/v2/LogsAggregateSort.md b/docs/v2/LogsAggregateSort.md index 2109a35d4375..48cf67029106 100644 --- a/docs/v2/LogsAggregateSort.md +++ b/docs/v2/LogsAggregateSort.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **aggregation** | [**LogsAggregationFunction**](LogsAggregationFunction.md) | | [optional] | -| **metric** | **String** | The metric to sort by (only used for `type=measure`) | [optional] | -| **order** | [**LogsSortOrder**](LogsSortOrder.md) | | [optional] | -| **type** | [**LogsAggregateSortType**](LogsAggregateSortType.md) | | [optional][default to 'alphabetical'] | +| Name | Type | Description | Notes | +| --------------- | --------------------------------------------------------- | ------------------------------------------------------------------- | --------------------------------------------- | +| **aggregation** | [**LogsAggregationFunction**](LogsAggregationFunction.md) | | [optional] | +| **metric** | **String** | The metric to sort by (only used for `type=measure`) | [optional] | +| **order** | [**LogsSortOrder**](LogsSortOrder.md) | | [optional] | +| **type** | [**LogsAggregateSortType**](LogsAggregateSortType.md) | | [optional][default to 'alphabetical'] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V2::LogsAggregateSort.new( type: null ) ``` - diff --git a/docs/v2/LogsAggregateSortType.md b/docs/v2/LogsAggregateSortType.md index 064f65971aac..fdfe29c368a7 100644 --- a/docs/v2/LogsAggregateSortType.md +++ b/docs/v2/LogsAggregateSortType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::LogsAggregateSortType.new() ``` - diff --git a/docs/v2/LogsAggregationFunction.md b/docs/v2/LogsAggregationFunction.md index 2644bcdcdbde..d63f230cfb12 100644 --- a/docs/v2/LogsAggregationFunction.md +++ b/docs/v2/LogsAggregationFunction.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::LogsAggregationFunction.new() ``` - diff --git a/docs/v2/LogsArchive.md b/docs/v2/LogsArchive.md index daac6c8a2846..bdbef0fdd1ac 100644 --- a/docs/v2/LogsArchive.md +++ b/docs/v2/LogsArchive.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**LogsArchiveDefinition**](LogsArchiveDefinition.md) | | [optional] | +| Name | Type | Description | Notes | +| -------- | ----------------------------------------------------- | ----------- | ---------- | +| **data** | [**LogsArchiveDefinition**](LogsArchiveDefinition.md) | | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::LogsArchive.new( data: null ) ``` - diff --git a/docs/v2/LogsArchiveAttributes.md b/docs/v2/LogsArchiveAttributes.md index 7c0989205a96..9a68368c363a 100644 --- a/docs/v2/LogsArchiveAttributes.md +++ b/docs/v2/LogsArchiveAttributes.md @@ -2,14 +2,14 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **destination** | [**LogsArchiveDestination**](LogsArchiveDestination.md) | | | -| **include_tags** | **Boolean** | To store the tags in the archive, set the value \"true\". If it is set to \"false\", the tags will be deleted when the logs are sent to the archive. | [optional][default to false] | -| **name** | **String** | The archive name. | | -| **query** | **String** | The archive query/filter. Logs matching this query are included in the archive. | | -| **rehydration_tags** | **Array<String>** | An array of tags to add to rehydrated logs from an archive. | [optional] | -| **state** | [**LogsArchiveState**](LogsArchiveState.md) | | [optional] | +| Name | Type | Description | Notes | +| -------------------- | ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------- | +| **destination** | [**LogsArchiveDestination**](LogsArchiveDestination.md) | | | +| **include_tags** | **Boolean** | To store the tags in the archive, set the value \"true\". If it is set to \"false\", the tags will be deleted when the logs are sent to the archive. | [optional][default to false] | +| **name** | **String** | The archive name. | | +| **query** | **String** | The archive query/filter. Logs matching this query are included in the archive. | | +| **rehydration_tags** | **Array<String>** | An array of tags to add to rehydrated logs from an archive. | [optional] | +| **state** | [**LogsArchiveState**](LogsArchiveState.md) | | [optional] | ## Example @@ -25,4 +25,3 @@ instance = DatadogAPIClient::V2::LogsArchiveAttributes.new( state: null ) ``` - diff --git a/docs/v2/LogsArchiveCreateRequest.md b/docs/v2/LogsArchiveCreateRequest.md index eb766b08dead..6f37bbc617b7 100644 --- a/docs/v2/LogsArchiveCreateRequest.md +++ b/docs/v2/LogsArchiveCreateRequest.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**LogsArchiveCreateRequestDefinition**](LogsArchiveCreateRequestDefinition.md) | | [optional] | +| Name | Type | Description | Notes | +| -------- | ------------------------------------------------------------------------------- | ----------- | ---------- | +| **data** | [**LogsArchiveCreateRequestDefinition**](LogsArchiveCreateRequestDefinition.md) | | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::LogsArchiveCreateRequest.new( data: null ) ``` - diff --git a/docs/v2/LogsArchiveCreateRequestAttributes.md b/docs/v2/LogsArchiveCreateRequestAttributes.md index 098d7a6b7245..7ba383ddfc1e 100644 --- a/docs/v2/LogsArchiveCreateRequestAttributes.md +++ b/docs/v2/LogsArchiveCreateRequestAttributes.md @@ -2,13 +2,13 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **destination** | [**LogsArchiveCreateRequestDestination**](LogsArchiveCreateRequestDestination.md) | | | -| **include_tags** | **Boolean** | To store the tags in the archive, set the value \"true\". If it is set to \"false\", the tags will be deleted when the logs are sent to the archive. | [optional][default to false] | -| **name** | **String** | The archive name. | | -| **query** | **String** | The archive query/filter. Logs matching this query are included in the archive. | | -| **rehydration_tags** | **Array<String>** | An array of tags to add to rehydrated logs from an archive. | [optional] | +| Name | Type | Description | Notes | +| -------------------- | --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------- | +| **destination** | [**LogsArchiveCreateRequestDestination**](LogsArchiveCreateRequestDestination.md) | | | +| **include_tags** | **Boolean** | To store the tags in the archive, set the value \"true\". If it is set to \"false\", the tags will be deleted when the logs are sent to the archive. | [optional][default to false] | +| **name** | **String** | The archive name. | | +| **query** | **String** | The archive query/filter. Logs matching this query are included in the archive. | | +| **rehydration_tags** | **Array<String>** | An array of tags to add to rehydrated logs from an archive. | [optional] | ## Example @@ -23,4 +23,3 @@ instance = DatadogAPIClient::V2::LogsArchiveCreateRequestAttributes.new( rehydration_tags: ["team:intake","team:app"] ) ``` - diff --git a/docs/v2/LogsArchiveCreateRequestDefinition.md b/docs/v2/LogsArchiveCreateRequestDefinition.md index e41942f17717..7e43a1055a8c 100644 --- a/docs/v2/LogsArchiveCreateRequestDefinition.md +++ b/docs/v2/LogsArchiveCreateRequestDefinition.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**LogsArchiveCreateRequestAttributes**](LogsArchiveCreateRequestAttributes.md) | | [optional] | -| **type** | **String** | The type of the resource. The value should always be archives. | [default to 'archives'] | +| Name | Type | Description | Notes | +| -------------- | ------------------------------------------------------------------------------- | -------------------------------------------------------------- | ------------------------------- | +| **attributes** | [**LogsArchiveCreateRequestAttributes**](LogsArchiveCreateRequestAttributes.md) | | [optional] | +| **type** | **String** | The type of the resource. The value should always be archives. | [default to 'archives'] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::LogsArchiveCreateRequestDefinition.new( type: archives ) ``` - diff --git a/docs/v2/LogsArchiveCreateRequestDestination.md b/docs/v2/LogsArchiveCreateRequestDestination.md index 2e36dfa564fb..2e73489a8067 100644 --- a/docs/v2/LogsArchiveCreateRequestDestination.md +++ b/docs/v2/LogsArchiveCreateRequestDestination.md @@ -38,8 +38,8 @@ DatadogAPIClient::V2::LogsArchiveCreateRequestDestination.build(data_that_doesnt #### Parameters -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| -------- | --------- | -------------------------------------------------- | | **data** | **Mixed** | data to be matched against the list of oneOf items | #### Return type @@ -48,4 +48,3 @@ DatadogAPIClient::V2::LogsArchiveCreateRequestDestination.build(data_that_doesnt - `LogsArchiveDestinationGCS` - `LogsArchiveDestinationS3` - `nil` (if no type matches) - diff --git a/docs/v2/LogsArchiveDefinition.md b/docs/v2/LogsArchiveDefinition.md index e3cc1d45c154..b1c76e559045 100644 --- a/docs/v2/LogsArchiveDefinition.md +++ b/docs/v2/LogsArchiveDefinition.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**LogsArchiveAttributes**](LogsArchiveAttributes.md) | | [optional] | -| **id** | **String** | The archive ID. | [optional][readonly] | -| **type** | **String** | The type of the resource. The value should always be archives. | [readonly][default to 'archives'] | +| Name | Type | Description | Notes | +| -------------- | ----------------------------------------------------- | -------------------------------------------------------------- | ----------------------------------------- | +| **attributes** | [**LogsArchiveAttributes**](LogsArchiveAttributes.md) | | [optional] | +| **id** | **String** | The archive ID. | [optional][readonly] | +| **type** | **String** | The type of the resource. The value should always be archives. | [readonly][default to 'archives'] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V2::LogsArchiveDefinition.new( type: archives ) ``` - diff --git a/docs/v2/LogsArchiveDestination.md b/docs/v2/LogsArchiveDestination.md index 8c02d31b120c..98a95d344d44 100644 --- a/docs/v2/LogsArchiveDestination.md +++ b/docs/v2/LogsArchiveDestination.md @@ -38,8 +38,8 @@ DatadogAPIClient::V2::LogsArchiveDestination.build(data_that_doesnt_match) #### Parameters -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| -------- | --------- | -------------------------------------------------- | | **data** | **Mixed** | data to be matched against the list of oneOf items | #### Return type @@ -48,4 +48,3 @@ DatadogAPIClient::V2::LogsArchiveDestination.build(data_that_doesnt_match) - `LogsArchiveDestinationGCS` - `LogsArchiveDestinationS3` - `nil` (if no type matches) - diff --git a/docs/v2/LogsArchiveDestinationAzure.md b/docs/v2/LogsArchiveDestinationAzure.md index 5a17b3230f2c..daa86128f05e 100644 --- a/docs/v2/LogsArchiveDestinationAzure.md +++ b/docs/v2/LogsArchiveDestinationAzure.md @@ -2,14 +2,14 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **container** | **String** | The container where the archive will be stored. | | -| **integration** | [**LogsArchiveIntegrationAzure**](LogsArchiveIntegrationAzure.md) | | | -| **path** | **String** | The archive path. | [optional] | -| **region** | **String** | The region where the archive will be stored. | [optional] | -| **storage_account** | **String** | The associated storage account. | | -| **type** | [**LogsArchiveDestinationAzureType**](LogsArchiveDestinationAzureType.md) | | [default to 'azure'] | +| Name | Type | Description | Notes | +| ------------------- | ------------------------------------------------------------------------- | ----------------------------------------------- | ---------------------------- | +| **container** | **String** | The container where the archive will be stored. | | +| **integration** | [**LogsArchiveIntegrationAzure**](LogsArchiveIntegrationAzure.md) | | | +| **path** | **String** | The archive path. | [optional] | +| **region** | **String** | The region where the archive will be stored. | [optional] | +| **storage_account** | **String** | The associated storage account. | | +| **type** | [**LogsArchiveDestinationAzureType**](LogsArchiveDestinationAzureType.md) | | [default to 'azure'] | ## Example @@ -25,4 +25,3 @@ instance = DatadogAPIClient::V2::LogsArchiveDestinationAzure.new( type: null ) ``` - diff --git a/docs/v2/LogsArchiveDestinationAzureType.md b/docs/v2/LogsArchiveDestinationAzureType.md index a6d0cfdbded7..9d8283cb734d 100644 --- a/docs/v2/LogsArchiveDestinationAzureType.md +++ b/docs/v2/LogsArchiveDestinationAzureType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::LogsArchiveDestinationAzureType.new() ``` - diff --git a/docs/v2/LogsArchiveDestinationGCS.md b/docs/v2/LogsArchiveDestinationGCS.md index 0892a45681bd..f33d25df6761 100644 --- a/docs/v2/LogsArchiveDestinationGCS.md +++ b/docs/v2/LogsArchiveDestinationGCS.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **bucket** | **String** | The bucket where the archive will be stored. | | -| **integration** | [**LogsArchiveIntegrationGCS**](LogsArchiveIntegrationGCS.md) | | | -| **path** | **String** | The archive path. | [optional] | -| **type** | [**LogsArchiveDestinationGCSType**](LogsArchiveDestinationGCSType.md) | | [default to 'gcs'] | +| Name | Type | Description | Notes | +| --------------- | --------------------------------------------------------------------- | -------------------------------------------- | -------------------------- | +| **bucket** | **String** | The bucket where the archive will be stored. | | +| **integration** | [**LogsArchiveIntegrationGCS**](LogsArchiveIntegrationGCS.md) | | | +| **path** | **String** | The archive path. | [optional] | +| **type** | [**LogsArchiveDestinationGCSType**](LogsArchiveDestinationGCSType.md) | | [default to 'gcs'] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V2::LogsArchiveDestinationGCS.new( type: null ) ``` - diff --git a/docs/v2/LogsArchiveDestinationGCSType.md b/docs/v2/LogsArchiveDestinationGCSType.md index 0622ffd917e3..cbe87a16e851 100644 --- a/docs/v2/LogsArchiveDestinationGCSType.md +++ b/docs/v2/LogsArchiveDestinationGCSType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::LogsArchiveDestinationGCSType.new() ``` - diff --git a/docs/v2/LogsArchiveDestinationS3.md b/docs/v2/LogsArchiveDestinationS3.md index 622b7b1739a2..519ebeb566d2 100644 --- a/docs/v2/LogsArchiveDestinationS3.md +++ b/docs/v2/LogsArchiveDestinationS3.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **bucket** | **String** | The bucket where the archive will be stored. | | -| **integration** | [**LogsArchiveIntegrationS3**](LogsArchiveIntegrationS3.md) | | | -| **path** | **String** | The archive path. | [optional] | -| **type** | [**LogsArchiveDestinationS3Type**](LogsArchiveDestinationS3Type.md) | | [default to 's3'] | +| Name | Type | Description | Notes | +| --------------- | ------------------------------------------------------------------- | -------------------------------------------- | ------------------------- | +| **bucket** | **String** | The bucket where the archive will be stored. | | +| **integration** | [**LogsArchiveIntegrationS3**](LogsArchiveIntegrationS3.md) | | | +| **path** | **String** | The archive path. | [optional] | +| **type** | [**LogsArchiveDestinationS3Type**](LogsArchiveDestinationS3Type.md) | | [default to 's3'] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V2::LogsArchiveDestinationS3.new( type: null ) ``` - diff --git a/docs/v2/LogsArchiveDestinationS3Type.md b/docs/v2/LogsArchiveDestinationS3Type.md index 461aa33d6f19..d96d7b3e44f1 100644 --- a/docs/v2/LogsArchiveDestinationS3Type.md +++ b/docs/v2/LogsArchiveDestinationS3Type.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::LogsArchiveDestinationS3Type.new() ``` - diff --git a/docs/v2/LogsArchiveIntegrationAzure.md b/docs/v2/LogsArchiveIntegrationAzure.md index 0c8d7924750a..0b8d6d0a4f5a 100644 --- a/docs/v2/LogsArchiveIntegrationAzure.md +++ b/docs/v2/LogsArchiveIntegrationAzure.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **client_id** | **String** | A client ID. | | -| **tenant_id** | **String** | A tenant ID. | | +| Name | Type | Description | Notes | +| ------------- | ---------- | ------------ | ----- | +| **client_id** | **String** | A client ID. | | +| **tenant_id** | **String** | A tenant ID. | | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::LogsArchiveIntegrationAzure.new( tenant_id: aaaaaaaa-1a1a-1a1a-1a1a-aaaaaaaaaaaa ) ``` - diff --git a/docs/v2/LogsArchiveIntegrationGCS.md b/docs/v2/LogsArchiveIntegrationGCS.md index eab31107b002..6a393ed80326 100644 --- a/docs/v2/LogsArchiveIntegrationGCS.md +++ b/docs/v2/LogsArchiveIntegrationGCS.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **client_email** | **String** | A client email. | | -| **project_id** | **String** | A project ID. | | +| Name | Type | Description | Notes | +| ---------------- | ---------- | --------------- | ----- | +| **client_email** | **String** | A client email. | | +| **project_id** | **String** | A project ID. | | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::LogsArchiveIntegrationGCS.new( project_id: project-id ) ``` - diff --git a/docs/v2/LogsArchiveIntegrationS3.md b/docs/v2/LogsArchiveIntegrationS3.md index 490cf48d2d7f..7a501c7f4b83 100644 --- a/docs/v2/LogsArchiveIntegrationS3.md +++ b/docs/v2/LogsArchiveIntegrationS3.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **account_id** | **String** | The account ID for the integration. | | -| **role_name** | **String** | The path of the integration. | | +| Name | Type | Description | Notes | +| -------------- | ---------- | ----------------------------------- | ----- | +| **account_id** | **String** | The account ID for the integration. | | +| **role_name** | **String** | The path of the integration. | | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::LogsArchiveIntegrationS3.new( role_name: role-name ) ``` - diff --git a/docs/v2/LogsArchiveOrder.md b/docs/v2/LogsArchiveOrder.md index 6b0c1dd7563d..dedd1241ff0c 100644 --- a/docs/v2/LogsArchiveOrder.md +++ b/docs/v2/LogsArchiveOrder.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**LogsArchiveOrderDefinition**](LogsArchiveOrderDefinition.md) | | [optional] | +| Name | Type | Description | Notes | +| -------- | --------------------------------------------------------------- | ----------- | ---------- | +| **data** | [**LogsArchiveOrderDefinition**](LogsArchiveOrderDefinition.md) | | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::LogsArchiveOrder.new( data: null ) ``` - diff --git a/docs/v2/LogsArchiveOrderAttributes.md b/docs/v2/LogsArchiveOrderAttributes.md index b1df74c24640..a2b9fcf6d283 100644 --- a/docs/v2/LogsArchiveOrderAttributes.md +++ b/docs/v2/LogsArchiveOrderAttributes.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **archive_ids** | **Array<String>** | An ordered array of `<ARCHIVE_ID>` strings, the order of archive IDs in the array define the overall archives order for Datadog. | | +| Name | Type | Description | Notes | +| --------------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ----- | +| **archive_ids** | **Array<String>** | An ordered array of `<ARCHIVE_ID>` strings, the order of archive IDs in the array define the overall archives order for Datadog. | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::LogsArchiveOrderAttributes.new( archive_ids: ["a2zcMylnM4OCHpYusxIi1g","a2zcMylnM4OCHpYusxIi2g","a2zcMylnM4OCHpYusxIi3g"] ) ``` - diff --git a/docs/v2/LogsArchiveOrderDefinition.md b/docs/v2/LogsArchiveOrderDefinition.md index 808a070c528c..fdfa2e889af0 100644 --- a/docs/v2/LogsArchiveOrderDefinition.md +++ b/docs/v2/LogsArchiveOrderDefinition.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**LogsArchiveOrderAttributes**](LogsArchiveOrderAttributes.md) | | | -| **type** | [**LogsArchiveOrderDefinitionType**](LogsArchiveOrderDefinitionType.md) | | [default to 'archive_order'] | +| Name | Type | Description | Notes | +| -------------- | ----------------------------------------------------------------------- | ----------- | ------------------------------------ | +| **attributes** | [**LogsArchiveOrderAttributes**](LogsArchiveOrderAttributes.md) | | | +| **type** | [**LogsArchiveOrderDefinitionType**](LogsArchiveOrderDefinitionType.md) | | [default to 'archive_order'] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::LogsArchiveOrderDefinition.new( type: null ) ``` - diff --git a/docs/v2/LogsArchiveOrderDefinitionType.md b/docs/v2/LogsArchiveOrderDefinitionType.md index 70b59d71df82..ebc0a56fcde8 100644 --- a/docs/v2/LogsArchiveOrderDefinitionType.md +++ b/docs/v2/LogsArchiveOrderDefinitionType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::LogsArchiveOrderDefinitionType.new() ``` - diff --git a/docs/v2/LogsArchiveState.md b/docs/v2/LogsArchiveState.md index 9319f22c455e..b0a285771b6d 100644 --- a/docs/v2/LogsArchiveState.md +++ b/docs/v2/LogsArchiveState.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::LogsArchiveState.new() ``` - diff --git a/docs/v2/LogsArchives.md b/docs/v2/LogsArchives.md index f5b2a0814c2a..7c68f6bd7b25 100644 --- a/docs/v2/LogsArchives.md +++ b/docs/v2/LogsArchives.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| -------- | ------------------------------------------------------------------ | ------------------- | ---------- | | **data** | [**Array<LogsArchiveDefinition>**](LogsArchiveDefinition.md) | A list of archives. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::LogsArchives.new( data: null ) ``` - diff --git a/docs/v2/LogsArchivesAPI.md b/docs/v2/LogsArchivesAPI.md index cb6ed7057bd9..7b2997cb12a0 100644 --- a/docs/v2/LogsArchivesAPI.md +++ b/docs/v2/LogsArchivesAPI.md @@ -2,19 +2,18 @@ All URIs are relative to *https://api.datadoghq.com* -| Method | HTTP request | Description | -| ------ | ------------ | ----------- | -| [**add_read_role_to_archive**](LogsArchivesAPI.md#add_read_role_to_archive) | **POST** /api/v2/logs/config/archives/{archive_id}/readers | Grant role to an archive | -| [**create_logs_archive**](LogsArchivesAPI.md#create_logs_archive) | **POST** /api/v2/logs/config/archives | Create an archive | -| [**delete_logs_archive**](LogsArchivesAPI.md#delete_logs_archive) | **DELETE** /api/v2/logs/config/archives/{archive_id} | Delete an archive | -| [**get_logs_archive**](LogsArchivesAPI.md#get_logs_archive) | **GET** /api/v2/logs/config/archives/{archive_id} | Get an archive | -| [**get_logs_archive_order**](LogsArchivesAPI.md#get_logs_archive_order) | **GET** /api/v2/logs/config/archive-order | Get archive order | -| [**list_archive_read_roles**](LogsArchivesAPI.md#list_archive_read_roles) | **GET** /api/v2/logs/config/archives/{archive_id}/readers | List read roles for an archive | -| [**list_logs_archives**](LogsArchivesAPI.md#list_logs_archives) | **GET** /api/v2/logs/config/archives | Get all archives | -| [**remove_role_from_archive**](LogsArchivesAPI.md#remove_role_from_archive) | **DELETE** /api/v2/logs/config/archives/{archive_id}/readers | Revoke role from an archive | -| [**update_logs_archive**](LogsArchivesAPI.md#update_logs_archive) | **PUT** /api/v2/logs/config/archives/{archive_id} | Update an archive | -| [**update_logs_archive_order**](LogsArchivesAPI.md#update_logs_archive_order) | **PUT** /api/v2/logs/config/archive-order | Update archive order | - +| Method | HTTP request | Description | +| ----------------------------------------------------------------------------- | ------------------------------------------------------------ | ------------------------------ | +| [**add_read_role_to_archive**](LogsArchivesAPI.md#add_read_role_to_archive) | **POST** /api/v2/logs/config/archives/{archive_id}/readers | Grant role to an archive | +| [**create_logs_archive**](LogsArchivesAPI.md#create_logs_archive) | **POST** /api/v2/logs/config/archives | Create an archive | +| [**delete_logs_archive**](LogsArchivesAPI.md#delete_logs_archive) | **DELETE** /api/v2/logs/config/archives/{archive_id} | Delete an archive | +| [**get_logs_archive**](LogsArchivesAPI.md#get_logs_archive) | **GET** /api/v2/logs/config/archives/{archive_id} | Get an archive | +| [**get_logs_archive_order**](LogsArchivesAPI.md#get_logs_archive_order) | **GET** /api/v2/logs/config/archive-order | Get archive order | +| [**list_archive_read_roles**](LogsArchivesAPI.md#list_archive_read_roles) | **GET** /api/v2/logs/config/archives/{archive_id}/readers | List read roles for an archive | +| [**list_logs_archives**](LogsArchivesAPI.md#list_logs_archives) | **GET** /api/v2/logs/config/archives | Get all archives | +| [**remove_role_from_archive**](LogsArchivesAPI.md#remove_role_from_archive) | **DELETE** /api/v2/logs/config/archives/{archive_id}/readers | Revoke role from an archive | +| [**update_logs_archive**](LogsArchivesAPI.md#update_logs_archive) | **PUT** /api/v2/logs/config/archives/{archive_id} | Update an archive | +| [**update_logs_archive_order**](LogsArchivesAPI.md#update_logs_archive_order) | **PUT** /api/v2/logs/config/archive-order | Update archive order | ## add_read_role_to_archive @@ -28,7 +27,7 @@ Adds a read role to an archive. ([Roles API](https://docs.datadoghq.com/api/v2/r require 'datadog_api_client' api_instance = DatadogAPIClient::V2::LogsArchivesAPI.new archive_id = 'archive_id_example' # String | The ID of the archive. -body = DatadogAPIClient::V2::RelationshipToRole.new # RelationshipToRole | +body = DatadogAPIClient::V2::RelationshipToRole.new # RelationshipToRole | begin # Grant role to an archive @@ -58,10 +57,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **archive_id** | **String** | The ID of the archive. | | -| **body** | [**RelationshipToRole**](RelationshipToRole.md) | | | +| Name | Type | Description | Notes | +| -------------- | ----------------------------------------------- | ---------------------- | ----- | +| **archive_id** | **String** | The ID of the archive. | | +| **body** | [**RelationshipToRole**](RelationshipToRole.md) | | | ### Return type @@ -76,7 +75,6 @@ nil (empty response body) - **Content-Type**: application/json - **Accept**: application/json - ## create_logs_archive > create_logs_archive(body) @@ -119,9 +117,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**LogsArchiveCreateRequest**](LogsArchiveCreateRequest.md) | The definition of the new archive. | | +| Name | Type | Description | Notes | +| -------- | ----------------------------------------------------------- | ---------------------------------- | ----- | +| **body** | [**LogsArchiveCreateRequest**](LogsArchiveCreateRequest.md) | The definition of the new archive. | | ### Return type @@ -136,7 +134,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## delete_logs_archive > delete_logs_archive(archive_id) @@ -178,9 +175,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **archive_id** | **String** | The ID of the archive. | | +| Name | Type | Description | Notes | +| -------------- | ---------- | ---------------------- | ----- | +| **archive_id** | **String** | The ID of the archive. | | ### Return type @@ -195,7 +192,6 @@ nil (empty response body) - **Content-Type**: Not defined - **Accept**: application/json - ## get_logs_archive > get_logs_archive(archive_id) @@ -238,9 +234,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **archive_id** | **String** | The ID of the archive. | | +| Name | Type | Description | Notes | +| -------------- | ---------- | ---------------------- | ----- | +| **archive_id** | **String** | The ID of the archive. | | ### Return type @@ -255,7 +251,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## get_logs_archive_order > get_logs_archive_order @@ -313,7 +308,6 @@ This endpoint does not need any parameter. - **Content-Type**: Not defined - **Accept**: application/json - ## list_archive_read_roles > list_archive_read_roles(archive_id) @@ -356,9 +350,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **archive_id** | **String** | The ID of the archive. | | +| Name | Type | Description | Notes | +| -------------- | ---------- | ---------------------- | ----- | +| **archive_id** | **String** | The ID of the archive. | | ### Return type @@ -373,7 +367,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## list_logs_archives > list_logs_archives @@ -430,7 +423,6 @@ This endpoint does not need any parameter. - **Content-Type**: Not defined - **Accept**: application/json - ## remove_role_from_archive > remove_role_from_archive(archive_id, body) @@ -443,7 +435,7 @@ Removes a role from an archive. ([Roles API](https://docs.datadoghq.com/api/v2/r require 'datadog_api_client' api_instance = DatadogAPIClient::V2::LogsArchivesAPI.new archive_id = 'archive_id_example' # String | The ID of the archive. -body = DatadogAPIClient::V2::RelationshipToRole.new # RelationshipToRole | +body = DatadogAPIClient::V2::RelationshipToRole.new # RelationshipToRole | begin # Revoke role from an archive @@ -473,10 +465,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **archive_id** | **String** | The ID of the archive. | | -| **body** | [**RelationshipToRole**](RelationshipToRole.md) | | | +| Name | Type | Description | Notes | +| -------------- | ----------------------------------------------- | ---------------------- | ----- | +| **archive_id** | **String** | The ID of the archive. | | +| **body** | [**RelationshipToRole**](RelationshipToRole.md) | | | ### Return type @@ -491,7 +483,6 @@ nil (empty response body) - **Content-Type**: application/json - **Accept**: application/json - ## update_logs_archive > update_logs_archive(archive_id, body) @@ -538,10 +529,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **archive_id** | **String** | The ID of the archive. | | -| **body** | [**LogsArchiveCreateRequest**](LogsArchiveCreateRequest.md) | New definition of the archive. | | +| Name | Type | Description | Notes | +| -------------- | ----------------------------------------------------------- | ------------------------------ | ----- | +| **archive_id** | **String** | The ID of the archive. | | +| **body** | [**LogsArchiveCreateRequest**](LogsArchiveCreateRequest.md) | New definition of the archive. | | ### Return type @@ -556,7 +547,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## update_logs_archive_order > update_logs_archive_order(body) @@ -603,9 +593,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**LogsArchiveOrder**](LogsArchiveOrder.md) | An object containing the new ordered list of archive IDs. | | +| Name | Type | Description | Notes | +| -------- | ------------------------------------------- | --------------------------------------------------------- | ----- | +| **body** | [**LogsArchiveOrder**](LogsArchiveOrder.md) | An object containing the new ordered list of archive IDs. | | ### Return type @@ -619,4 +609,3 @@ end - **Content-Type**: application/json - **Accept**: application/json - diff --git a/docs/v2/LogsCompute.md b/docs/v2/LogsCompute.md index 72ac4b6eac93..38fe87a8e740 100644 --- a/docs/v2/LogsCompute.md +++ b/docs/v2/LogsCompute.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **aggregation** | [**LogsAggregationFunction**](LogsAggregationFunction.md) | | | -| **interval** | **String** | The time buckets' size (only used for type=timeseries) Defaults to a resolution of 150 points | [optional] | -| **metric** | **String** | The metric to use | [optional] | -| **type** | [**LogsComputeType**](LogsComputeType.md) | | [optional][default to 'total'] | +| Name | Type | Description | Notes | +| --------------- | --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | -------------------------------------- | +| **aggregation** | [**LogsAggregationFunction**](LogsAggregationFunction.md) | | | +| **interval** | **String** | The time buckets' size (only used for type=timeseries) Defaults to a resolution of 150 points | [optional] | +| **metric** | **String** | The metric to use | [optional] | +| **type** | [**LogsComputeType**](LogsComputeType.md) | | [optional][default to 'total'] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V2::LogsCompute.new( type: null ) ``` - diff --git a/docs/v2/LogsComputeType.md b/docs/v2/LogsComputeType.md index 9b499e7549d1..be6c7d9a030b 100644 --- a/docs/v2/LogsComputeType.md +++ b/docs/v2/LogsComputeType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::LogsComputeType.new() ``` - diff --git a/docs/v2/LogsGroupBy.md b/docs/v2/LogsGroupBy.md index 4d1ec4a7132d..48e468b0854e 100644 --- a/docs/v2/LogsGroupBy.md +++ b/docs/v2/LogsGroupBy.md @@ -2,14 +2,14 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **facet** | **String** | The name of the facet to use (required) | | -| **histogram** | [**LogsGroupByHistogram**](LogsGroupByHistogram.md) | | [optional] | -| **limit** | **Integer** | The maximum buckets to return for this group by | [optional][default to 10] | -| **missing** | [**LogsGroupByMissing**](LogsGroupByMissing.md) | | [optional] | -| **sort** | [**LogsAggregateSort**](LogsAggregateSort.md) | | [optional] | -| **total** | [**LogsGroupByTotal**](LogsGroupByTotal.md) | | [optional] | +| Name | Type | Description | Notes | +| ------------- | --------------------------------------------------- | ----------------------------------------------- | ------------------------- | +| **facet** | **String** | The name of the facet to use (required) | | +| **histogram** | [**LogsGroupByHistogram**](LogsGroupByHistogram.md) | | [optional] | +| **limit** | **Integer** | The maximum buckets to return for this group by | [optional][default to 10] | +| **missing** | [**LogsGroupByMissing**](LogsGroupByMissing.md) | | [optional] | +| **sort** | [**LogsAggregateSort**](LogsAggregateSort.md) | | [optional] | +| **total** | [**LogsGroupByTotal**](LogsGroupByTotal.md) | | [optional] | ## Example @@ -25,4 +25,3 @@ instance = DatadogAPIClient::V2::LogsGroupBy.new( total: null ) ``` - diff --git a/docs/v2/LogsGroupByHistogram.md b/docs/v2/LogsGroupByHistogram.md index 11ed711db12d..66dcab7881cd 100644 --- a/docs/v2/LogsGroupByHistogram.md +++ b/docs/v2/LogsGroupByHistogram.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **interval** | **Float** | The bin size of the histogram buckets | | -| **max** | **Float** | The maximum value for the measure used in the histogram (values greater than this one are filtered out) | | -| **min** | **Float** | The minimum value for the measure used in the histogram (values smaller than this one are filtered out) | | +| Name | Type | Description | Notes | +| ------------ | --------- | ------------------------------------------------------------------------------------------------------- | ----- | +| **interval** | **Float** | The bin size of the histogram buckets | | +| **max** | **Float** | The maximum value for the measure used in the histogram (values greater than this one are filtered out) | | +| **min** | **Float** | The minimum value for the measure used in the histogram (values smaller than this one are filtered out) | | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V2::LogsGroupByHistogram.new( min: 50 ) ``` - diff --git a/docs/v2/LogsGroupByMissing.md b/docs/v2/LogsGroupByMissing.md index 82d1750a8cdd..049d907d4a6b 100644 --- a/docs/v2/LogsGroupByMissing.md +++ b/docs/v2/LogsGroupByMissing.md @@ -37,8 +37,8 @@ DatadogAPIClient::V2::LogsGroupByMissing.build(data_that_doesnt_match) #### Parameters -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| -------- | --------- | -------------------------------------------------- | | **data** | **Mixed** | data to be matched against the list of oneOf items | #### Return type @@ -46,4 +46,3 @@ DatadogAPIClient::V2::LogsGroupByMissing.build(data_that_doesnt_match) - `Float` - `String` - `nil` (if no type matches) - diff --git a/docs/v2/LogsGroupByTotal.md b/docs/v2/LogsGroupByTotal.md index a232409eab7c..ccc54f8a1b96 100644 --- a/docs/v2/LogsGroupByTotal.md +++ b/docs/v2/LogsGroupByTotal.md @@ -38,8 +38,8 @@ DatadogAPIClient::V2::LogsGroupByTotal.build(data_that_doesnt_match) #### Parameters -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| -------- | --------- | -------------------------------------------------- | | **data** | **Mixed** | data to be matched against the list of oneOf items | #### Return type @@ -48,4 +48,3 @@ DatadogAPIClient::V2::LogsGroupByTotal.build(data_that_doesnt_match) - `Float` - `String` - `nil` (if no type matches) - diff --git a/docs/v2/LogsListRequest.md b/docs/v2/LogsListRequest.md index e541fcac36d4..9ce08b6c7c6b 100644 --- a/docs/v2/LogsListRequest.md +++ b/docs/v2/LogsListRequest.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **filter** | [**LogsQueryFilter**](LogsQueryFilter.md) | | [optional] | -| **options** | [**LogsQueryOptions**](LogsQueryOptions.md) | | [optional] | -| **page** | [**LogsListRequestPage**](LogsListRequestPage.md) | | [optional] | -| **sort** | [**LogsSort**](LogsSort.md) | | [optional] | +| Name | Type | Description | Notes | +| ----------- | ------------------------------------------------- | ----------- | ---------- | +| **filter** | [**LogsQueryFilter**](LogsQueryFilter.md) | | [optional] | +| **options** | [**LogsQueryOptions**](LogsQueryOptions.md) | | [optional] | +| **page** | [**LogsListRequestPage**](LogsListRequestPage.md) | | [optional] | +| **sort** | [**LogsSort**](LogsSort.md) | | [optional] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V2::LogsListRequest.new( sort: null ) ``` - diff --git a/docs/v2/LogsListRequestPage.md b/docs/v2/LogsListRequestPage.md index ee69c6475309..e46660a33a7f 100644 --- a/docs/v2/LogsListRequestPage.md +++ b/docs/v2/LogsListRequestPage.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **cursor** | **String** | List following results with a cursor provided in the previous query. | [optional] | -| **limit** | **Integer** | Maximum number of logs in the response. | [optional][default to 10] | +| Name | Type | Description | Notes | +| ---------- | ----------- | -------------------------------------------------------------------- | ------------------------- | +| **cursor** | **String** | List following results with a cursor provided in the previous query. | [optional] | +| **limit** | **Integer** | Maximum number of logs in the response. | [optional][default to 10] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::LogsListRequestPage.new( limit: 25 ) ``` - diff --git a/docs/v2/LogsListResponse.md b/docs/v2/LogsListResponse.md index 9f26f5bee6fe..a8129831d184 100644 --- a/docs/v2/LogsListResponse.md +++ b/docs/v2/LogsListResponse.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**Array<Log>**](Log.md) | Array of logs matching the request. | [optional] | -| **links** | [**LogsListResponseLinks**](LogsListResponseLinks.md) | | [optional] | -| **meta** | [**LogsResponseMetadata**](LogsResponseMetadata.md) | | [optional] | +| Name | Type | Description | Notes | +| --------- | ----------------------------------------------------- | ----------------------------------- | ---------- | +| **data** | [**Array<Log>**](Log.md) | Array of logs matching the request. | [optional] | +| **links** | [**LogsListResponseLinks**](LogsListResponseLinks.md) | | [optional] | +| **meta** | [**LogsResponseMetadata**](LogsResponseMetadata.md) | | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V2::LogsListResponse.new( meta: null ) ``` - diff --git a/docs/v2/LogsListResponseLinks.md b/docs/v2/LogsListResponseLinks.md index 46076375efb2..ec5d83620a36 100644 --- a/docs/v2/LogsListResponseLinks.md +++ b/docs/v2/LogsListResponseLinks.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **_next** | **String** | Link for the next set of results. Note that the request can also be made using the POST endpoint. | [optional] | +| Name | Type | Description | Notes | +| ---------- | ---------- | ------------------------------------------------------------------------------------------------- | ---------- | +| **\_next** | **String** | Link for the next set of results. Note that the request can also be made using the POST endpoint. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::LogsListResponseLinks.new( _next: https://app.datadoghq.com/api/v2/logs/event?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== ) ``` - diff --git a/docs/v2/LogsMetricCompute.md b/docs/v2/LogsMetricCompute.md index 708be5e491a6..58363d76057b 100644 --- a/docs/v2/LogsMetricCompute.md +++ b/docs/v2/LogsMetricCompute.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **aggregation_type** | [**LogsMetricComputeAggregationType**](LogsMetricComputeAggregationType.md) | | | -| **path** | **String** | The path to the value the log-based metric will aggregate on (only used if the aggregation type is a \"distribution\"). | [optional] | +| Name | Type | Description | Notes | +| -------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **aggregation_type** | [**LogsMetricComputeAggregationType**](LogsMetricComputeAggregationType.md) | | | +| **path** | **String** | The path to the value the log-based metric will aggregate on (only used if the aggregation type is a \"distribution\"). | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::LogsMetricCompute.new( path: @duration ) ``` - diff --git a/docs/v2/LogsMetricComputeAggregationType.md b/docs/v2/LogsMetricComputeAggregationType.md index b11f006ec4ba..2eaa55aed895 100644 --- a/docs/v2/LogsMetricComputeAggregationType.md +++ b/docs/v2/LogsMetricComputeAggregationType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::LogsMetricComputeAggregationType.new() ``` - diff --git a/docs/v2/LogsMetricCreateAttributes.md b/docs/v2/LogsMetricCreateAttributes.md index 73cd8e79d453..2e61f14ae536 100644 --- a/docs/v2/LogsMetricCreateAttributes.md +++ b/docs/v2/LogsMetricCreateAttributes.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **compute** | [**LogsMetricCompute**](LogsMetricCompute.md) | | | -| **filter** | [**LogsMetricFilter**](LogsMetricFilter.md) | | [optional] | +| Name | Type | Description | Notes | +| ------------ | ---------------------------------------------------------- | --------------------------- | ---------- | +| **compute** | [**LogsMetricCompute**](LogsMetricCompute.md) | | | +| **filter** | [**LogsMetricFilter**](LogsMetricFilter.md) | | [optional] | | **group_by** | [**Array<LogsMetricGroupBy>**](LogsMetricGroupBy.md) | The rules for the group by. | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V2::LogsMetricCreateAttributes.new( group_by: null ) ``` - diff --git a/docs/v2/LogsMetricCreateData.md b/docs/v2/LogsMetricCreateData.md index 950205d0e270..4b0d9b6ccc2f 100644 --- a/docs/v2/LogsMetricCreateData.md +++ b/docs/v2/LogsMetricCreateData.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**LogsMetricCreateAttributes**](LogsMetricCreateAttributes.md) | | | -| **id** | **String** | The name of the log-based metric. | | -| **type** | [**LogsMetricType**](LogsMetricType.md) | | [default to 'logs_metrics'] | +| Name | Type | Description | Notes | +| -------------- | --------------------------------------------------------------- | --------------------------------- | ----------------------------------- | +| **attributes** | [**LogsMetricCreateAttributes**](LogsMetricCreateAttributes.md) | | | +| **id** | **String** | The name of the log-based metric. | | +| **type** | [**LogsMetricType**](LogsMetricType.md) | | [default to 'logs_metrics'] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V2::LogsMetricCreateData.new( type: null ) ``` - diff --git a/docs/v2/LogsMetricCreateRequest.md b/docs/v2/LogsMetricCreateRequest.md index e8d362fe74b6..ebaea24887a5 100644 --- a/docs/v2/LogsMetricCreateRequest.md +++ b/docs/v2/LogsMetricCreateRequest.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**LogsMetricCreateData**](LogsMetricCreateData.md) | | | +| Name | Type | Description | Notes | +| -------- | --------------------------------------------------- | ----------- | ----- | +| **data** | [**LogsMetricCreateData**](LogsMetricCreateData.md) | | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::LogsMetricCreateRequest.new( data: null ) ``` - diff --git a/docs/v2/LogsMetricFilter.md b/docs/v2/LogsMetricFilter.md index 1f1e76c8bb28..51af975ef62b 100644 --- a/docs/v2/LogsMetricFilter.md +++ b/docs/v2/LogsMetricFilter.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| --------- | ---------- | --------------------------------------------------- | ---------------------------------- | | **query** | **String** | The search query - following the log search syntax. | [optional][default to '*'] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::LogsMetricFilter.new( query: service:web* AND @http.status_code:[200 TO 299] ) ``` - diff --git a/docs/v2/LogsMetricGroupBy.md b/docs/v2/LogsMetricGroupBy.md index 30a18a38feb4..4d8adcdfa167 100644 --- a/docs/v2/LogsMetricGroupBy.md +++ b/docs/v2/LogsMetricGroupBy.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **path** | **String** | The path to the value the log-based metric will be aggregated over. | | +| Name | Type | Description | Notes | +| ------------ | ---------- | --------------------------------------------------------------------------------------------------- | ---------- | +| **path** | **String** | The path to the value the log-based metric will be aggregated over. | | | **tag_name** | **String** | Eventual name of the tag that gets created. By default, the path attribute is used as the tag name. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::LogsMetricGroupBy.new( tag_name: status_code ) ``` - diff --git a/docs/v2/LogsMetricResponse.md b/docs/v2/LogsMetricResponse.md index 9dc7b6a4e859..5be9529e6d84 100644 --- a/docs/v2/LogsMetricResponse.md +++ b/docs/v2/LogsMetricResponse.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**LogsMetricResponseData**](LogsMetricResponseData.md) | | [optional] | +| Name | Type | Description | Notes | +| -------- | ------------------------------------------------------- | ----------- | ---------- | +| **data** | [**LogsMetricResponseData**](LogsMetricResponseData.md) | | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::LogsMetricResponse.new( data: null ) ``` - diff --git a/docs/v2/LogsMetricResponseAttributes.md b/docs/v2/LogsMetricResponseAttributes.md index 4f37dfcd18de..2719589215c0 100644 --- a/docs/v2/LogsMetricResponseAttributes.md +++ b/docs/v2/LogsMetricResponseAttributes.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **compute** | [**LogsMetricResponseCompute**](LogsMetricResponseCompute.md) | | [optional] | -| **filter** | [**LogsMetricResponseFilter**](LogsMetricResponseFilter.md) | | [optional] | +| Name | Type | Description | Notes | +| ------------ | -------------------------------------------------------------------------- | --------------------------- | ---------- | +| **compute** | [**LogsMetricResponseCompute**](LogsMetricResponseCompute.md) | | [optional] | +| **filter** | [**LogsMetricResponseFilter**](LogsMetricResponseFilter.md) | | [optional] | | **group_by** | [**Array<LogsMetricResponseGroupBy>**](LogsMetricResponseGroupBy.md) | The rules for the group by. | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V2::LogsMetricResponseAttributes.new( group_by: null ) ``` - diff --git a/docs/v2/LogsMetricResponseCompute.md b/docs/v2/LogsMetricResponseCompute.md index dc69fcfae776..2cdc1d10f0ee 100644 --- a/docs/v2/LogsMetricResponseCompute.md +++ b/docs/v2/LogsMetricResponseCompute.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **aggregation_type** | [**LogsMetricResponseComputeAggregationType**](LogsMetricResponseComputeAggregationType.md) | | [optional] | -| **path** | **String** | The path to the value the log-based metric will aggregate on (only used if the aggregation type is a \"distribution\"). | [optional] | +| Name | Type | Description | Notes | +| -------------------- | ------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **aggregation_type** | [**LogsMetricResponseComputeAggregationType**](LogsMetricResponseComputeAggregationType.md) | | [optional] | +| **path** | **String** | The path to the value the log-based metric will aggregate on (only used if the aggregation type is a \"distribution\"). | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::LogsMetricResponseCompute.new( path: @duration ) ``` - diff --git a/docs/v2/LogsMetricResponseComputeAggregationType.md b/docs/v2/LogsMetricResponseComputeAggregationType.md index c10857aa8d33..899540b0110f 100644 --- a/docs/v2/LogsMetricResponseComputeAggregationType.md +++ b/docs/v2/LogsMetricResponseComputeAggregationType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::LogsMetricResponseComputeAggregationType.new() ``` - diff --git a/docs/v2/LogsMetricResponseData.md b/docs/v2/LogsMetricResponseData.md index b4b00b45687b..f5759785ac68 100644 --- a/docs/v2/LogsMetricResponseData.md +++ b/docs/v2/LogsMetricResponseData.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**LogsMetricResponseAttributes**](LogsMetricResponseAttributes.md) | | [optional] | -| **id** | **String** | The name of the log-based metric. | [optional] | -| **type** | [**LogsMetricType**](LogsMetricType.md) | | [optional][default to 'logs_metrics'] | +| Name | Type | Description | Notes | +| -------------- | ------------------------------------------------------------------- | --------------------------------- | --------------------------------------------- | +| **attributes** | [**LogsMetricResponseAttributes**](LogsMetricResponseAttributes.md) | | [optional] | +| **id** | **String** | The name of the log-based metric. | [optional] | +| **type** | [**LogsMetricType**](LogsMetricType.md) | | [optional][default to 'logs_metrics'] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V2::LogsMetricResponseData.new( type: null ) ``` - diff --git a/docs/v2/LogsMetricResponseFilter.md b/docs/v2/LogsMetricResponseFilter.md index 062e302ebaeb..e74a1e0b5046 100644 --- a/docs/v2/LogsMetricResponseFilter.md +++ b/docs/v2/LogsMetricResponseFilter.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| --------- | ---------- | --------------------------------------------------- | ---------- | | **query** | **String** | The search query - following the log search syntax. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::LogsMetricResponseFilter.new( query: service:web* AND @http.status_code:[200 TO 299] ) ``` - diff --git a/docs/v2/LogsMetricResponseGroupBy.md b/docs/v2/LogsMetricResponseGroupBy.md index dc2ac8b67411..286ee18866c4 100644 --- a/docs/v2/LogsMetricResponseGroupBy.md +++ b/docs/v2/LogsMetricResponseGroupBy.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **path** | **String** | The path to the value the log-based metric will be aggregated over. | [optional] | +| Name | Type | Description | Notes | +| ------------ | ---------- | --------------------------------------------------------------------------------------------------- | ---------- | +| **path** | **String** | The path to the value the log-based metric will be aggregated over. | [optional] | | **tag_name** | **String** | Eventual name of the tag that gets created. By default, the path attribute is used as the tag name. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::LogsMetricResponseGroupBy.new( tag_name: status_code ) ``` - diff --git a/docs/v2/LogsMetricType.md b/docs/v2/LogsMetricType.md index 9116bd6d82e2..ab40ab191ba4 100644 --- a/docs/v2/LogsMetricType.md +++ b/docs/v2/LogsMetricType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::LogsMetricType.new() ``` - diff --git a/docs/v2/LogsMetricUpdateAttributes.md b/docs/v2/LogsMetricUpdateAttributes.md index 6254dc653d65..8a9c6a02eb86 100644 --- a/docs/v2/LogsMetricUpdateAttributes.md +++ b/docs/v2/LogsMetricUpdateAttributes.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **filter** | [**LogsMetricFilter**](LogsMetricFilter.md) | | [optional] | +| Name | Type | Description | Notes | +| ------------ | ---------------------------------------------------------- | --------------------------- | ---------- | +| **filter** | [**LogsMetricFilter**](LogsMetricFilter.md) | | [optional] | | **group_by** | [**Array<LogsMetricGroupBy>**](LogsMetricGroupBy.md) | The rules for the group by. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::LogsMetricUpdateAttributes.new( group_by: null ) ``` - diff --git a/docs/v2/LogsMetricUpdateData.md b/docs/v2/LogsMetricUpdateData.md index b2f17f2e33a0..579d526feae8 100644 --- a/docs/v2/LogsMetricUpdateData.md +++ b/docs/v2/LogsMetricUpdateData.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**LogsMetricUpdateAttributes**](LogsMetricUpdateAttributes.md) | | | -| **type** | [**LogsMetricType**](LogsMetricType.md) | | [default to 'logs_metrics'] | +| Name | Type | Description | Notes | +| -------------- | --------------------------------------------------------------- | ----------- | ----------------------------------- | +| **attributes** | [**LogsMetricUpdateAttributes**](LogsMetricUpdateAttributes.md) | | | +| **type** | [**LogsMetricType**](LogsMetricType.md) | | [default to 'logs_metrics'] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::LogsMetricUpdateData.new( type: null ) ``` - diff --git a/docs/v2/LogsMetricUpdateRequest.md b/docs/v2/LogsMetricUpdateRequest.md index 2bb2ea0dabed..5d5b44357042 100644 --- a/docs/v2/LogsMetricUpdateRequest.md +++ b/docs/v2/LogsMetricUpdateRequest.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**LogsMetricUpdateData**](LogsMetricUpdateData.md) | | | +| Name | Type | Description | Notes | +| -------- | --------------------------------------------------- | ----------- | ----- | +| **data** | [**LogsMetricUpdateData**](LogsMetricUpdateData.md) | | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::LogsMetricUpdateRequest.new( data: null ) ``` - diff --git a/docs/v2/LogsMetricsAPI.md b/docs/v2/LogsMetricsAPI.md index c7b244bd77b1..6634e92cbb55 100644 --- a/docs/v2/LogsMetricsAPI.md +++ b/docs/v2/LogsMetricsAPI.md @@ -2,14 +2,13 @@ All URIs are relative to *https://api.datadoghq.com* -| Method | HTTP request | Description | -| ------ | ------------ | ----------- | -| [**create_logs_metric**](LogsMetricsAPI.md#create_logs_metric) | **POST** /api/v2/logs/config/metrics | Create a log-based metric | +| Method | HTTP request | Description | +| -------------------------------------------------------------- | -------------------------------------------------- | ------------------------- | +| [**create_logs_metric**](LogsMetricsAPI.md#create_logs_metric) | **POST** /api/v2/logs/config/metrics | Create a log-based metric | | [**delete_logs_metric**](LogsMetricsAPI.md#delete_logs_metric) | **DELETE** /api/v2/logs/config/metrics/{metric_id} | Delete a log-based metric | -| [**get_logs_metric**](LogsMetricsAPI.md#get_logs_metric) | **GET** /api/v2/logs/config/metrics/{metric_id} | Get a log-based metric | -| [**list_logs_metrics**](LogsMetricsAPI.md#list_logs_metrics) | **GET** /api/v2/logs/config/metrics | Get all log-based metrics | -| [**update_logs_metric**](LogsMetricsAPI.md#update_logs_metric) | **PATCH** /api/v2/logs/config/metrics/{metric_id} | Update a log-based metric | - +| [**get_logs_metric**](LogsMetricsAPI.md#get_logs_metric) | **GET** /api/v2/logs/config/metrics/{metric_id} | Get a log-based metric | +| [**list_logs_metrics**](LogsMetricsAPI.md#list_logs_metrics) | **GET** /api/v2/logs/config/metrics | Get all log-based metrics | +| [**update_logs_metric**](LogsMetricsAPI.md#update_logs_metric) | **PATCH** /api/v2/logs/config/metrics/{metric_id} | Update a log-based metric | ## create_logs_metric @@ -54,9 +53,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**LogsMetricCreateRequest**](LogsMetricCreateRequest.md) | The definition of the new log-based metric. | | +| Name | Type | Description | Notes | +| -------- | --------------------------------------------------------- | ------------------------------------------- | ----- | +| **body** | [**LogsMetricCreateRequest**](LogsMetricCreateRequest.md) | The definition of the new log-based metric. | | ### Return type @@ -71,7 +70,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## delete_logs_metric > delete_logs_metric(metric_id) @@ -113,9 +111,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **metric_id** | **String** | The name of the log-based metric. | | +| Name | Type | Description | Notes | +| ------------- | ---------- | --------------------------------- | ----- | +| **metric_id** | **String** | The name of the log-based metric. | | ### Return type @@ -130,7 +128,6 @@ nil (empty response body) - **Content-Type**: Not defined - **Accept**: application/json - ## get_logs_metric > get_logs_metric(metric_id) @@ -173,9 +170,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **metric_id** | **String** | The name of the log-based metric. | | +| Name | Type | Description | Notes | +| ------------- | ---------- | --------------------------------- | ----- | +| **metric_id** | **String** | The name of the log-based metric. | | ### Return type @@ -190,7 +187,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## list_logs_metrics > list_logs_metrics @@ -247,7 +243,6 @@ This endpoint does not need any parameter. - **Content-Type**: Not defined - **Accept**: application/json - ## update_logs_metric > update_logs_metric(metric_id, body) @@ -292,10 +287,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **metric_id** | **String** | The name of the log-based metric. | | -| **body** | [**LogsMetricUpdateRequest**](LogsMetricUpdateRequest.md) | New definition of the log-based metric. | | +| Name | Type | Description | Notes | +| ------------- | --------------------------------------------------------- | --------------------------------------- | ----- | +| **metric_id** | **String** | The name of the log-based metric. | | +| **body** | [**LogsMetricUpdateRequest**](LogsMetricUpdateRequest.md) | New definition of the log-based metric. | | ### Return type @@ -309,4 +304,3 @@ end - **Content-Type**: application/json - **Accept**: application/json - diff --git a/docs/v2/LogsMetricsResponse.md b/docs/v2/LogsMetricsResponse.md index 1a3b9bd1d083..39c5b3710552 100644 --- a/docs/v2/LogsMetricsResponse.md +++ b/docs/v2/LogsMetricsResponse.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| -------- | -------------------------------------------------------------------- | ----------------------------------- | ---------- | | **data** | [**Array<LogsMetricResponseData>**](LogsMetricResponseData.md) | A list of log-based metric objects. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::LogsMetricsResponse.new( data: null ) ``` - diff --git a/docs/v2/LogsQueryFilter.md b/docs/v2/LogsQueryFilter.md index c63ac39fc2d9..e0e2c0cb2ebf 100644 --- a/docs/v2/LogsQueryFilter.md +++ b/docs/v2/LogsQueryFilter.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **from** | **String** | The minimum time for the requested logs, supports date math and regular timestamps | [optional][default to 'now-15m'] | -| **indexes** | **Array<String>** | For customers with multiple indexes, the indexes to search. Defaults to ['*'] which means all indexes. | [optional] | -| **query** | **String** | The search query - following the log search syntax. | [optional][default to '*'] | -| **to** | **String** | The maximum time for the requested logs, supports date math and regular timestamps | [optional][default to 'now'] | +| Name | Type | Description | Notes | +| ----------- | ----------------------- | -------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | +| **from** | **String** | The minimum time for the requested logs, supports date math and regular timestamps | [optional][default to 'now-15m'] | +| **indexes** | **Array<String>** | For customers with multiple indexes, the indexes to search. Defaults to ['*'] which means all indexes. | [optional] | +| **query** | **String** | The search query - following the log search syntax. | [optional][default to '*'] | +| **to** | **String** | The maximum time for the requested logs, supports date math and regular timestamps | [optional][default to 'now'] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V2::LogsQueryFilter.new( to: now ) ``` - diff --git a/docs/v2/LogsQueryOptions.md b/docs/v2/LogsQueryOptions.md index 2e8b92be6d1c..2c5e62ae02c9 100644 --- a/docs/v2/LogsQueryOptions.md +++ b/docs/v2/LogsQueryOptions.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **time_offset** | **Integer** | The time offset (in seconds) to apply to the query. | [optional] | -| **timezone** | **String** | The timezone can be specified both as an offset, for example: \"UTC+03:00\". | [optional][default to 'UTC'] | +| Name | Type | Description | Notes | +| --------------- | ----------- | -------------------------------------------------------------------------------------- | ------------------------------------ | +| **time_offset** | **Integer** | The time offset (in seconds) to apply to the query. | [optional] | +| **timezone** | **String** | The timezone can be specified both as an offset, for example: \"UTC+03:00\". | [optional][default to 'utc'] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::LogsQueryOptions.new( timezone: GMT ) ``` - diff --git a/docs/v2/LogsResponseMetadata.md b/docs/v2/LogsResponseMetadata.md index 36443b31bf0e..2f0b866ab29a 100644 --- a/docs/v2/LogsResponseMetadata.md +++ b/docs/v2/LogsResponseMetadata.md @@ -2,13 +2,13 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **elapsed** | **Integer** | The time elapsed in milliseconds | [optional] | -| **page** | [**LogsResponseMetadataPage**](LogsResponseMetadataPage.md) | | [optional] | -| **request_id** | **String** | The identifier of the request | [optional] | -| **status** | [**LogsAggregateResponseStatus**](LogsAggregateResponseStatus.md) | | [optional] | -| **warnings** | [**Array<LogsWarning>**](LogsWarning.md) | A list of warnings (non fatal errors) encountered, partial results might be returned if warnings are present in the response. | [optional] | +| Name | Type | Description | Notes | +| -------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **elapsed** | **Integer** | The time elapsed in milliseconds | [optional] | +| **page** | [**LogsResponseMetadataPage**](LogsResponseMetadataPage.md) | | [optional] | +| **request_id** | **String** | The identifier of the request | [optional] | +| **status** | [**LogsAggregateResponseStatus**](LogsAggregateResponseStatus.md) | | [optional] | +| **warnings** | [**Array<LogsWarning>**](LogsWarning.md) | A list of warnings (non fatal errors) encountered, partial results might be returned if warnings are present in the response. | [optional] | ## Example @@ -23,4 +23,3 @@ instance = DatadogAPIClient::V2::LogsResponseMetadata.new( warnings: null ) ``` - diff --git a/docs/v2/LogsResponseMetadataPage.md b/docs/v2/LogsResponseMetadataPage.md index b9754202a8f5..9b936fe0ca2d 100644 --- a/docs/v2/LogsResponseMetadataPage.md +++ b/docs/v2/LogsResponseMetadataPage.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| --------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | | **after** | **String** | The cursor to use to get the next results, if any. To make the next request, use the same. parameters with the addition of the `page[cursor]`. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::LogsResponseMetadataPage.new( after: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== ) ``` - diff --git a/docs/v2/LogsSort.md b/docs/v2/LogsSort.md index ae42e1172ff3..047781e7f4b7 100644 --- a/docs/v2/LogsSort.md +++ b/docs/v2/LogsSort.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::LogsSort.new() ``` - diff --git a/docs/v2/LogsSortOrder.md b/docs/v2/LogsSortOrder.md index 511f8a7dfefb..2d16d4e8ea8c 100644 --- a/docs/v2/LogsSortOrder.md +++ b/docs/v2/LogsSortOrder.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::LogsSortOrder.new() ``` - diff --git a/docs/v2/LogsWarning.md b/docs/v2/LogsWarning.md index 4fe51e10e853..0ad658db92d2 100644 --- a/docs/v2/LogsWarning.md +++ b/docs/v2/LogsWarning.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **code** | **String** | A unique code for this type of warning | [optional] | +| Name | Type | Description | Notes | +| ---------- | ---------- | ----------------------------------------------- | ---------- | +| **code** | **String** | A unique code for this type of warning | [optional] | | **detail** | **String** | A detailed explanation of this specific warning | [optional] | -| **title** | **String** | A short human-readable summary of the warning | [optional] | +| **title** | **String** | A short human-readable summary of the warning | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V2::LogsWarning.new( title: One or several indexes are missing or invalid, results hold data from the other indexes ) ``` - diff --git a/docs/v2/Metric.md b/docs/v2/Metric.md index 898b8a86a14b..b2f8c0703c37 100644 --- a/docs/v2/Metric.md +++ b/docs/v2/Metric.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **id** | **String** | The metric name for this resource. | [optional] | -| **type** | [**MetricType**](MetricType.md) | | [optional][default to 'metrics'] | +| Name | Type | Description | Notes | +| -------- | ------------------------------- | ---------------------------------- | ---------------------------------------- | +| **id** | **String** | The metric name for this resource. | [optional] | +| **type** | [**MetricType**](MetricType.md) | | [optional][default to 'metrics'] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::Metric.new( type: null ) ``` - diff --git a/docs/v2/MetricAllTags.md b/docs/v2/MetricAllTags.md index 5f25db76862d..1b7c0b8e713a 100644 --- a/docs/v2/MetricAllTags.md +++ b/docs/v2/MetricAllTags.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**MetricAllTagsAttributes**](MetricAllTagsAttributes.md) | | [optional] | -| **id** | **String** | The metric name for this resource. | [optional] | -| **type** | [**MetricType**](MetricType.md) | | [optional][default to 'metrics'] | +| Name | Type | Description | Notes | +| -------------- | --------------------------------------------------------- | ---------------------------------- | ---------------------------------------- | +| **attributes** | [**MetricAllTagsAttributes**](MetricAllTagsAttributes.md) | | [optional] | +| **id** | **String** | The metric name for this resource. | [optional] | +| **type** | [**MetricType**](MetricType.md) | | [optional][default to 'metrics'] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V2::MetricAllTags.new( type: null ) ``` - diff --git a/docs/v2/MetricAllTagsAttributes.md b/docs/v2/MetricAllTagsAttributes.md index db149e2df1b8..a9988c6277e4 100644 --- a/docs/v2/MetricAllTagsAttributes.md +++ b/docs/v2/MetricAllTagsAttributes.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| -------- | ----------------------- | -------------------------------- | ---------- | | **tags** | **Array<String>** | List of indexed tag value pairs. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::MetricAllTagsAttributes.new( tags: ["sport:golf","sport:football","animal:dog"] ) ``` - diff --git a/docs/v2/MetricAllTagsResponse.md b/docs/v2/MetricAllTagsResponse.md index f25ba14ba7f0..4c61e9fd2633 100644 --- a/docs/v2/MetricAllTagsResponse.md +++ b/docs/v2/MetricAllTagsResponse.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**MetricAllTags**](MetricAllTags.md) | | [optional] | +| Name | Type | Description | Notes | +| -------- | ------------------------------------- | ----------- | ---------- | +| **data** | [**MetricAllTags**](MetricAllTags.md) | | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::MetricAllTagsResponse.new( data: null ) ``` - diff --git a/docs/v2/MetricCustomAggregation.md b/docs/v2/MetricCustomAggregation.md index 0c37c6a83e62..8e2851702d9e 100644 --- a/docs/v2/MetricCustomAggregation.md +++ b/docs/v2/MetricCustomAggregation.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **space** | [**MetricCustomSpaceAggregation**](MetricCustomSpaceAggregation.md) | | | -| **time** | [**MetricCustomTimeAggregation**](MetricCustomTimeAggregation.md) | | | +| Name | Type | Description | Notes | +| --------- | ------------------------------------------------------------------- | ----------- | ----- | +| **space** | [**MetricCustomSpaceAggregation**](MetricCustomSpaceAggregation.md) | | | +| **time** | [**MetricCustomTimeAggregation**](MetricCustomTimeAggregation.md) | | | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::MetricCustomAggregation.new( time: null ) ``` - diff --git a/docs/v2/MetricCustomSpaceAggregation.md b/docs/v2/MetricCustomSpaceAggregation.md index a6c6c394c681..23218eb092b2 100644 --- a/docs/v2/MetricCustomSpaceAggregation.md +++ b/docs/v2/MetricCustomSpaceAggregation.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::MetricCustomSpaceAggregation.new() ``` - diff --git a/docs/v2/MetricCustomTimeAggregation.md b/docs/v2/MetricCustomTimeAggregation.md index e4ace11fed0f..25e6f2f6fb61 100644 --- a/docs/v2/MetricCustomTimeAggregation.md +++ b/docs/v2/MetricCustomTimeAggregation.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::MetricCustomTimeAggregation.new() ``` - diff --git a/docs/v2/MetricDistinctVolume.md b/docs/v2/MetricDistinctVolume.md index 72f081123368..ed154f310103 100644 --- a/docs/v2/MetricDistinctVolume.md +++ b/docs/v2/MetricDistinctVolume.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**MetricDistinctVolumeAttributes**](MetricDistinctVolumeAttributes.md) | | [optional] | -| **id** | **String** | The metric name for this resource. | [optional] | -| **type** | [**MetricDistinctVolumeType**](MetricDistinctVolumeType.md) | | [optional][default to 'distinct_metric_volumes'] | +| Name | Type | Description | Notes | +| -------------- | ----------------------------------------------------------------------- | ---------------------------------- | -------------------------------------------------------- | +| **attributes** | [**MetricDistinctVolumeAttributes**](MetricDistinctVolumeAttributes.md) | | [optional] | +| **id** | **String** | The metric name for this resource. | [optional] | +| **type** | [**MetricDistinctVolumeType**](MetricDistinctVolumeType.md) | | [optional][default to 'distinct_metric_volumes'] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V2::MetricDistinctVolume.new( type: null ) ``` - diff --git a/docs/v2/MetricDistinctVolumeAttributes.md b/docs/v2/MetricDistinctVolumeAttributes.md index 6cad6d80940f..224b1c26d503 100644 --- a/docs/v2/MetricDistinctVolumeAttributes.md +++ b/docs/v2/MetricDistinctVolumeAttributes.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| ------------------- | ----------- | ------------------------------------- | ---------- | | **distinct_volume** | **Integer** | Distinct volume for the given metric. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::MetricDistinctVolumeAttributes.new( distinct_volume: 10 ) ``` - diff --git a/docs/v2/MetricDistinctVolumeType.md b/docs/v2/MetricDistinctVolumeType.md index c3e3cd07aa6f..0839c8b585ad 100644 --- a/docs/v2/MetricDistinctVolumeType.md +++ b/docs/v2/MetricDistinctVolumeType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::MetricDistinctVolumeType.new() ``` - diff --git a/docs/v2/MetricIngestedIndexedVolume.md b/docs/v2/MetricIngestedIndexedVolume.md index c783157b46d6..c6ab05b3734a 100644 --- a/docs/v2/MetricIngestedIndexedVolume.md +++ b/docs/v2/MetricIngestedIndexedVolume.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**MetricIngestedIndexedVolumeAttributes**](MetricIngestedIndexedVolumeAttributes.md) | | [optional] | -| **id** | **String** | The metric name for this resource. | [optional] | -| **type** | [**MetricIngestedIndexedVolumeType**](MetricIngestedIndexedVolumeType.md) | | [optional][default to 'metric_volumes'] | +| Name | Type | Description | Notes | +| -------------- | ------------------------------------------------------------------------------------- | ---------------------------------- | ----------------------------------------------- | +| **attributes** | [**MetricIngestedIndexedVolumeAttributes**](MetricIngestedIndexedVolumeAttributes.md) | | [optional] | +| **id** | **String** | The metric name for this resource. | [optional] | +| **type** | [**MetricIngestedIndexedVolumeType**](MetricIngestedIndexedVolumeType.md) | | [optional][default to 'metric_volumes'] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V2::MetricIngestedIndexedVolume.new( type: null ) ``` - diff --git a/docs/v2/MetricIngestedIndexedVolumeAttributes.md b/docs/v2/MetricIngestedIndexedVolumeAttributes.md index 4a9bf1aad804..518770986a02 100644 --- a/docs/v2/MetricIngestedIndexedVolumeAttributes.md +++ b/docs/v2/MetricIngestedIndexedVolumeAttributes.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **indexed_volume** | **Integer** | Indexed volume for the given metric. | [optional] | +| Name | Type | Description | Notes | +| ------------------- | ----------- | ------------------------------------- | ---------- | +| **indexed_volume** | **Integer** | Indexed volume for the given metric. | [optional] | | **ingested_volume** | **Integer** | Ingested volume for the given metric. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::MetricIngestedIndexedVolumeAttributes.new( ingested_volume: 20 ) ``` - diff --git a/docs/v2/MetricIngestedIndexedVolumeType.md b/docs/v2/MetricIngestedIndexedVolumeType.md index f2e89f7a8911..c487b5eb5ef9 100644 --- a/docs/v2/MetricIngestedIndexedVolumeType.md +++ b/docs/v2/MetricIngestedIndexedVolumeType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::MetricIngestedIndexedVolumeType.new() ``` - diff --git a/docs/v2/MetricTagConfiguration.md b/docs/v2/MetricTagConfiguration.md index fda472c2b67f..84d24060dbe8 100644 --- a/docs/v2/MetricTagConfiguration.md +++ b/docs/v2/MetricTagConfiguration.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**MetricTagConfigurationAttributes**](MetricTagConfigurationAttributes.md) | | [optional] | -| **id** | **String** | The metric name for this resource. | [optional] | -| **type** | [**MetricTagConfigurationType**](MetricTagConfigurationType.md) | | [optional][default to 'manage_tags'] | +| Name | Type | Description | Notes | +| -------------- | --------------------------------------------------------------------------- | ---------------------------------- | -------------------------------------------- | +| **attributes** | [**MetricTagConfigurationAttributes**](MetricTagConfigurationAttributes.md) | | [optional] | +| **id** | **String** | The metric name for this resource. | [optional] | +| **type** | [**MetricTagConfigurationType**](MetricTagConfigurationType.md) | | [optional][default to 'manage_tags'] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V2::MetricTagConfiguration.new( type: null ) ``` - diff --git a/docs/v2/MetricTagConfigurationAttributes.md b/docs/v2/MetricTagConfigurationAttributes.md index 81549fddbfe8..f682baf99845 100644 --- a/docs/v2/MetricTagConfigurationAttributes.md +++ b/docs/v2/MetricTagConfigurationAttributes.md @@ -2,14 +2,14 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **aggregations** | [**Array<MetricCustomAggregation>**](MetricCustomAggregation.md) | A list of queryable aggregation combinations for a count, rate, or gauge metric. By default, count and rate metrics require the (time: sum, space: sum) aggregation and Gauge metrics require the (time: avg, space: avg) aggregation. Additional time & space combinations are also available: - time: avg, space: avg - time: avg, space: max - time: avg, space: min - time: avg, space: sum - time: count, space: sum - time: max, space: max - time: min, space: min - time: sum, space: avg - time: sum, space: sum Can only be applied to metrics that have a `metric_type` of `count`, `rate`, or `gauge`. | [optional] | -| **created_at** | **Time** | Timestamp when the tag configuration was created. | [optional] | -| **include_percentiles** | **Boolean** | Toggle to turn on/off percentile aggregations for distribution metrics. Only present when the `metric_type` is `distribution`. | [optional] | -| **metric_type** | [**MetricTagConfigurationMetricTypes**](MetricTagConfigurationMetricTypes.md) | | [optional][default to 'gauge'] | -| **modified_at** | **Time** | Timestamp when the tag configuration was last modified. | [optional] | -| **tags** | **Array<String>** | List of tag keys on which to group. | [optional] | +| Name | Type | Description | Notes | +| ----------------------- | ----------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------- | +| **aggregations** | [**Array<MetricCustomAggregation>**](MetricCustomAggregation.md) | A list of queryable aggregation combinations for a count, rate, or gauge metric. By default, count and rate metrics require the (time: sum, space: sum) aggregation and Gauge metrics require the (time: avg, space: avg) aggregation. Additional time & space combinations are also available: - time: avg, space: avg - time: avg, space: max - time: avg, space: min - time: avg, space: sum - time: count, space: sum - time: max, space: max - time: min, space: min - time: sum, space: avg - time: sum, space: sum Can only be applied to metrics that have a `metric_type` of `count`, `rate`, or `gauge`. | [optional] | +| **created_at** | **Time** | Timestamp when the tag configuration was created. | [optional] | +| **include_percentiles** | **Boolean** | Toggle to turn on/off percentile aggregations for distribution metrics. Only present when the `metric_type` is `distribution`. | [optional] | +| **metric_type** | [**MetricTagConfigurationMetricTypes**](MetricTagConfigurationMetricTypes.md) | | [optional][default to 'gauge'] | +| **modified_at** | **Time** | Timestamp when the tag configuration was last modified. | [optional] | +| **tags** | **Array<String>** | List of tag keys on which to group. | [optional] | ## Example @@ -25,4 +25,3 @@ instance = DatadogAPIClient::V2::MetricTagConfigurationAttributes.new( tags: ["app","datacenter"] ) ``` - diff --git a/docs/v2/MetricTagConfigurationCreateAttributes.md b/docs/v2/MetricTagConfigurationCreateAttributes.md index 177c1bc1a062..927e910b0add 100644 --- a/docs/v2/MetricTagConfigurationCreateAttributes.md +++ b/docs/v2/MetricTagConfigurationCreateAttributes.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **aggregations** | [**Array<MetricCustomAggregation>**](MetricCustomAggregation.md) | A list of queryable aggregation combinations for a count, rate, or gauge metric. By default, count and rate metrics require the (time: sum, space: sum) aggregation and Gauge metrics require the (time: avg, space: avg) aggregation. Additional time & space combinations are also available: - time: avg, space: avg - time: avg, space: max - time: avg, space: min - time: avg, space: sum - time: count, space: sum - time: max, space: max - time: min, space: min - time: sum, space: avg - time: sum, space: sum Can only be applied to metrics that have a `metric_type` of `count`, `rate`, or `gauge`. | [optional] | -| **include_percentiles** | **Boolean** | Toggle to include/exclude percentiles for a distribution metric. Defaults to false. Can only be applied to metrics that have a `metric_type` of `distribution`. | [optional][default to false] | -| **metric_type** | [**MetricTagConfigurationMetricTypes**](MetricTagConfigurationMetricTypes.md) | | [default to 'gauge'] | -| **tags** | **Array<String>** | A list of tag keys that will be queryable for your metric. | | +| Name | Type | Description | Notes | +| ----------------------- | ----------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | +| **aggregations** | [**Array<MetricCustomAggregation>**](MetricCustomAggregation.md) | A list of queryable aggregation combinations for a count, rate, or gauge metric. By default, count and rate metrics require the (time: sum, space: sum) aggregation and Gauge metrics require the (time: avg, space: avg) aggregation. Additional time & space combinations are also available: - time: avg, space: avg - time: avg, space: max - time: avg, space: min - time: avg, space: sum - time: count, space: sum - time: max, space: max - time: min, space: min - time: sum, space: avg - time: sum, space: sum Can only be applied to metrics that have a `metric_type` of `count`, `rate`, or `gauge`. | [optional] | +| **include_percentiles** | **Boolean** | Toggle to include/exclude percentiles for a distribution metric. Defaults to false. Can only be applied to metrics that have a `metric_type` of `distribution`. | [optional][default to false] | +| **metric_type** | [**MetricTagConfigurationMetricTypes**](MetricTagConfigurationMetricTypes.md) | | [default to 'gauge'] | +| **tags** | **Array<String>** | A list of tag keys that will be queryable for your metric. | | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V2::MetricTagConfigurationCreateAttributes.new( tags: ["app","datacenter"] ) ``` - diff --git a/docs/v2/MetricTagConfigurationCreateData.md b/docs/v2/MetricTagConfigurationCreateData.md index 61932a8e072b..808f5e7946a6 100644 --- a/docs/v2/MetricTagConfigurationCreateData.md +++ b/docs/v2/MetricTagConfigurationCreateData.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**MetricTagConfigurationCreateAttributes**](MetricTagConfigurationCreateAttributes.md) | | [optional] | -| **id** | **String** | The metric name for this resource. | | -| **type** | [**MetricTagConfigurationType**](MetricTagConfigurationType.md) | | [default to 'manage_tags'] | +| Name | Type | Description | Notes | +| -------------- | --------------------------------------------------------------------------------------- | ---------------------------------- | ---------------------------------- | +| **attributes** | [**MetricTagConfigurationCreateAttributes**](MetricTagConfigurationCreateAttributes.md) | | [optional] | +| **id** | **String** | The metric name for this resource. | | +| **type** | [**MetricTagConfigurationType**](MetricTagConfigurationType.md) | | [default to 'manage_tags'] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V2::MetricTagConfigurationCreateData.new( type: null ) ``` - diff --git a/docs/v2/MetricTagConfigurationCreateRequest.md b/docs/v2/MetricTagConfigurationCreateRequest.md index 61c7011ded94..09eae8c20619 100644 --- a/docs/v2/MetricTagConfigurationCreateRequest.md +++ b/docs/v2/MetricTagConfigurationCreateRequest.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**MetricTagConfigurationCreateData**](MetricTagConfigurationCreateData.md) | | | +| Name | Type | Description | Notes | +| -------- | --------------------------------------------------------------------------- | ----------- | ----- | +| **data** | [**MetricTagConfigurationCreateData**](MetricTagConfigurationCreateData.md) | | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::MetricTagConfigurationCreateRequest.new( data: null ) ``` - diff --git a/docs/v2/MetricTagConfigurationMetricTypes.md b/docs/v2/MetricTagConfigurationMetricTypes.md index 25557e626b60..72b1d65a5a32 100644 --- a/docs/v2/MetricTagConfigurationMetricTypes.md +++ b/docs/v2/MetricTagConfigurationMetricTypes.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::MetricTagConfigurationMetricTypes.new() ``` - diff --git a/docs/v2/MetricTagConfigurationResponse.md b/docs/v2/MetricTagConfigurationResponse.md index 62919b23b8a6..cb84d9f7b9bf 100644 --- a/docs/v2/MetricTagConfigurationResponse.md +++ b/docs/v2/MetricTagConfigurationResponse.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**MetricTagConfiguration**](MetricTagConfiguration.md) | | [optional] | +| Name | Type | Description | Notes | +| -------- | ------------------------------------------------------- | ----------- | ---------- | +| **data** | [**MetricTagConfiguration**](MetricTagConfiguration.md) | | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::MetricTagConfigurationResponse.new( data: null ) ``` - diff --git a/docs/v2/MetricTagConfigurationType.md b/docs/v2/MetricTagConfigurationType.md index 7927a793bc3f..7e765eaf1d4b 100644 --- a/docs/v2/MetricTagConfigurationType.md +++ b/docs/v2/MetricTagConfigurationType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::MetricTagConfigurationType.new() ``` - diff --git a/docs/v2/MetricTagConfigurationUpdateAttributes.md b/docs/v2/MetricTagConfigurationUpdateAttributes.md index 951fc87c9f77..5320cb283485 100644 --- a/docs/v2/MetricTagConfigurationUpdateAttributes.md +++ b/docs/v2/MetricTagConfigurationUpdateAttributes.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **aggregations** | [**Array<MetricCustomAggregation>**](MetricCustomAggregation.md) | A list of queryable aggregation combinations for a count, rate, or gauge metric. By default, count and rate metrics require the (time: sum, space: sum) aggregation and Gauge metrics require the (time: avg, space: avg) aggregation. Additional time & space combinations are also available: - time: avg, space: avg - time: avg, space: max - time: avg, space: min - time: avg, space: sum - time: count, space: sum - time: max, space: max - time: min, space: min - time: sum, space: avg - time: sum, space: sum Can only be applied to metrics that have a `metric_type` of `count`, `rate`, or `gauge`. | [optional] | -| **include_percentiles** | **Boolean** | Toggle to include/exclude percentiles for a distribution metric. Defaults to false. Can only be applied to metrics that have a `metric_type` of `distribution`. | [optional][default to false] | -| **tags** | **Array<String>** | A list of tag keys that will be queryable for your metric. | [optional] | +| Name | Type | Description | Notes | +| ----------------------- | ---------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | +| **aggregations** | [**Array<MetricCustomAggregation>**](MetricCustomAggregation.md) | A list of queryable aggregation combinations for a count, rate, or gauge metric. By default, count and rate metrics require the (time: sum, space: sum) aggregation and Gauge metrics require the (time: avg, space: avg) aggregation. Additional time & space combinations are also available: - time: avg, space: avg - time: avg, space: max - time: avg, space: min - time: avg, space: sum - time: count, space: sum - time: max, space: max - time: min, space: min - time: sum, space: avg - time: sum, space: sum Can only be applied to metrics that have a `metric_type` of `count`, `rate`, or `gauge`. | [optional] | +| **include_percentiles** | **Boolean** | Toggle to include/exclude percentiles for a distribution metric. Defaults to false. Can only be applied to metrics that have a `metric_type` of `distribution`. | [optional][default to false] | +| **tags** | **Array<String>** | A list of tag keys that will be queryable for your metric. | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V2::MetricTagConfigurationUpdateAttributes.new( tags: ["app","datacenter"] ) ``` - diff --git a/docs/v2/MetricTagConfigurationUpdateData.md b/docs/v2/MetricTagConfigurationUpdateData.md index 342d8c7e0431..5d89876bf0e9 100644 --- a/docs/v2/MetricTagConfigurationUpdateData.md +++ b/docs/v2/MetricTagConfigurationUpdateData.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**MetricTagConfigurationUpdateAttributes**](MetricTagConfigurationUpdateAttributes.md) | | [optional] | -| **id** | **String** | The metric name for this resource. | | -| **type** | [**MetricTagConfigurationType**](MetricTagConfigurationType.md) | | [default to 'manage_tags'] | +| Name | Type | Description | Notes | +| -------------- | --------------------------------------------------------------------------------------- | ---------------------------------- | ---------------------------------- | +| **attributes** | [**MetricTagConfigurationUpdateAttributes**](MetricTagConfigurationUpdateAttributes.md) | | [optional] | +| **id** | **String** | The metric name for this resource. | | +| **type** | [**MetricTagConfigurationType**](MetricTagConfigurationType.md) | | [default to 'manage_tags'] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V2::MetricTagConfigurationUpdateData.new( type: null ) ``` - diff --git a/docs/v2/MetricTagConfigurationUpdateRequest.md b/docs/v2/MetricTagConfigurationUpdateRequest.md index 82fe210cdb13..76c769853ad7 100644 --- a/docs/v2/MetricTagConfigurationUpdateRequest.md +++ b/docs/v2/MetricTagConfigurationUpdateRequest.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**MetricTagConfigurationUpdateData**](MetricTagConfigurationUpdateData.md) | | | +| Name | Type | Description | Notes | +| -------- | --------------------------------------------------------------------------- | ----------- | ----- | +| **data** | [**MetricTagConfigurationUpdateData**](MetricTagConfigurationUpdateData.md) | | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::MetricTagConfigurationUpdateRequest.new( data: null ) ``` - diff --git a/docs/v2/MetricType.md b/docs/v2/MetricType.md index d0d9327c062f..325622b11152 100644 --- a/docs/v2/MetricType.md +++ b/docs/v2/MetricType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::MetricType.new() ``` - diff --git a/docs/v2/MetricVolumes.md b/docs/v2/MetricVolumes.md index 8e0060e4df21..6018ee0164c1 100644 --- a/docs/v2/MetricVolumes.md +++ b/docs/v2/MetricVolumes.md @@ -37,8 +37,8 @@ DatadogAPIClient::V2::MetricVolumes.build(data_that_doesnt_match) #### Parameters -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| -------- | --------- | -------------------------------------------------- | | **data** | **Mixed** | data to be matched against the list of oneOf items | #### Return type @@ -46,4 +46,3 @@ DatadogAPIClient::V2::MetricVolumes.build(data_that_doesnt_match) - `MetricDistinctVolume` - `MetricIngestedIndexedVolume` - `nil` (if no type matches) - diff --git a/docs/v2/MetricVolumesResponse.md b/docs/v2/MetricVolumesResponse.md index 034746a22839..128e4ff8ff79 100644 --- a/docs/v2/MetricVolumesResponse.md +++ b/docs/v2/MetricVolumesResponse.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**MetricVolumes**](MetricVolumes.md) | | [optional] | +| Name | Type | Description | Notes | +| -------- | ------------------------------------- | ----------- | ---------- | +| **data** | [**MetricVolumes**](MetricVolumes.md) | | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::MetricVolumesResponse.new( data: null ) ``` - diff --git a/docs/v2/MetricsAPI.md b/docs/v2/MetricsAPI.md index fafcdec6525f..3354889edbfa 100644 --- a/docs/v2/MetricsAPI.md +++ b/docs/v2/MetricsAPI.md @@ -2,16 +2,15 @@ All URIs are relative to *https://api.datadoghq.com* -| Method | HTTP request | Description | -| ------ | ------------ | ----------- | -| [**create_tag_configuration**](MetricsAPI.md#create_tag_configuration) | **POST** /api/v2/metrics/{metric_name}/tags | Create a tag configuration | -| [**delete_tag_configuration**](MetricsAPI.md#delete_tag_configuration) | **DELETE** /api/v2/metrics/{metric_name}/tags | Delete a tag configuration | -| [**list_tag_configuration_by_name**](MetricsAPI.md#list_tag_configuration_by_name) | **GET** /api/v2/metrics/{metric_name}/tags | List tag configuration by name | -| [**list_tag_configurations**](MetricsAPI.md#list_tag_configurations) | **GET** /api/v2/metrics | List tag configurations | -| [**list_tags_by_metric_name**](MetricsAPI.md#list_tags_by_metric_name) | **GET** /api/v2/metrics/{metric_name}/all-tags | List tags by metric name | -| [**list_volumes_by_metric_name**](MetricsAPI.md#list_volumes_by_metric_name) | **GET** /api/v2/metrics/{metric_name}/volumes | List distinct metric volumes by metric name | -| [**update_tag_configuration**](MetricsAPI.md#update_tag_configuration) | **PATCH** /api/v2/metrics/{metric_name}/tags | Update a tag configuration | - +| Method | HTTP request | Description | +| ---------------------------------------------------------------------------------- | ---------------------------------------------- | ------------------------------------------- | +| [**create_tag_configuration**](MetricsAPI.md#create_tag_configuration) | **POST** /api/v2/metrics/{metric_name}/tags | Create a tag configuration | +| [**delete_tag_configuration**](MetricsAPI.md#delete_tag_configuration) | **DELETE** /api/v2/metrics/{metric_name}/tags | Delete a tag configuration | +| [**list_tag_configuration_by_name**](MetricsAPI.md#list_tag_configuration_by_name) | **GET** /api/v2/metrics/{metric_name}/tags | List tag configuration by name | +| [**list_tag_configurations**](MetricsAPI.md#list_tag_configurations) | **GET** /api/v2/metrics | List tag configurations | +| [**list_tags_by_metric_name**](MetricsAPI.md#list_tags_by_metric_name) | **GET** /api/v2/metrics/{metric_name}/all-tags | List tags by metric name | +| [**list_volumes_by_metric_name**](MetricsAPI.md#list_volumes_by_metric_name) | **GET** /api/v2/metrics/{metric_name}/volumes | List distinct metric volumes by metric name | +| [**update_tag_configuration**](MetricsAPI.md#update_tag_configuration) | **PATCH** /api/v2/metrics/{metric_name}/tags | Update a tag configuration | ## create_tag_configuration @@ -33,7 +32,7 @@ end api_instance = DatadogAPIClient::V2::MetricsAPI.new metric_name = 'dist.http.endpoint.request' # String | The name of the metric. -body = DatadogAPIClient::V2::MetricTagConfigurationCreateRequest.new({data: DatadogAPIClient::V2::MetricTagConfigurationCreateData.new({id: 'test.metric.latency', type: DatadogAPIClient::V2::MetricTagConfigurationType::MANAGE_TAGS})}) # MetricTagConfigurationCreateRequest | +body = DatadogAPIClient::V2::MetricTagConfigurationCreateRequest.new({data: DatadogAPIClient::V2::MetricTagConfigurationCreateData.new({id: 'test.metric.latency', type: DatadogAPIClient::V2::MetricTagConfigurationType::MANAGE_TAGS})}) # MetricTagConfigurationCreateRequest | begin # Create a tag configuration @@ -64,10 +63,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **metric_name** | **String** | The name of the metric. | | -| **body** | [**MetricTagConfigurationCreateRequest**](MetricTagConfigurationCreateRequest.md) | | | +| Name | Type | Description | Notes | +| --------------- | --------------------------------------------------------------------------------- | ----------------------- | ----- | +| **metric_name** | **String** | The name of the metric. | | +| **body** | [**MetricTagConfigurationCreateRequest**](MetricTagConfigurationCreateRequest.md) | | | ### Return type @@ -82,7 +81,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## delete_tag_configuration > delete_tag_configuration(metric_name) @@ -130,9 +128,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **metric_name** | **String** | The name of the metric. | | +| Name | Type | Description | Notes | +| --------------- | ---------- | ----------------------- | ----- | +| **metric_name** | **String** | The name of the metric. | | ### Return type @@ -147,7 +145,6 @@ nil (empty response body) - **Content-Type**: Not defined - **Accept**: application/json - ## list_tag_configuration_by_name > list_tag_configuration_by_name(metric_name) @@ -195,9 +192,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **metric_name** | **String** | The name of the metric. | | +| Name | Type | Description | Notes | +| --------------- | ---------- | ----------------------- | ----- | +| **metric_name** | **String** | The name of the metric. | | ### Return type @@ -212,7 +209,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## list_tag_configurations > list_tag_configurations(opts) @@ -268,14 +264,14 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **filter_configured** | **Boolean** | Filter metrics that have configured tags. | [optional] | -| **filter_tags_configured** | **String** | Filter tag configurations by configured tags. | [optional] | -| **filter_metric_type** | **MetricTagConfigurationMetricTypes** | Filter tag configurations by metric type. | [optional][default to 'gauge'] | -| **filter_include_percentiles** | **Boolean** | Filter distributions with additional percentile aggregations enabled or disabled. | [optional] | -| **filter_tags** | **String** | Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions. Cannot be combined with other filters. | [optional] | -| **window_seconds** | **Integer** | The number of seconds of look back (from now) to apply to a filter[tag] query. Defaults value is 3600 (1 hour), maximum value is 172,800 (2 days). | [optional] | +| Name | Type | Description | Notes | +| ------------------------------ | ------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------- | +| **filter_configured** | **Boolean** | Filter metrics that have configured tags. | [optional] | +| **filter_tags_configured** | **String** | Filter tag configurations by configured tags. | [optional] | +| **filter_metric_type** | **MetricTagConfigurationMetricTypes** | Filter tag configurations by metric type. | [optional][default to 'gauge'] | +| **filter_include_percentiles** | **Boolean** | Filter distributions with additional percentile aggregations enabled or disabled. | [optional] | +| **filter_tags** | **String** | Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions. Cannot be combined with other filters. | [optional] | +| **window_seconds** | **Integer** | The number of seconds of look back (from now) to apply to a filter[tag] query. Defaults value is 3600 (1 hour), maximum value is 172,800 (2 days). | [optional] | ### Return type @@ -290,7 +286,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## list_tags_by_metric_name > list_tags_by_metric_name(metric_name) @@ -333,9 +328,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **metric_name** | **String** | The name of the metric. | | +| Name | Type | Description | Notes | +| --------------- | ---------- | ----------------------- | ----- | +| **metric_name** | **String** | The name of the metric. | | ### Return type @@ -350,7 +345,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## list_volumes_by_metric_name > list_volumes_by_metric_name(metric_name) @@ -397,9 +391,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **metric_name** | **String** | The name of the metric. | | +| Name | Type | Description | Notes | +| --------------- | ---------- | ----------------------- | ----- | +| **metric_name** | **String** | The name of the metric. | | ### Return type @@ -414,7 +408,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## update_tag_configuration > update_tag_configuration(metric_name, body) @@ -434,7 +427,7 @@ end api_instance = DatadogAPIClient::V2::MetricsAPI.new metric_name = 'dist.http.endpoint.request' # String | The name of the metric. -body = DatadogAPIClient::V2::MetricTagConfigurationUpdateRequest.new({data: DatadogAPIClient::V2::MetricTagConfigurationUpdateData.new({id: 'test.metric.latency', type: DatadogAPIClient::V2::MetricTagConfigurationType::MANAGE_TAGS})}) # MetricTagConfigurationUpdateRequest | +body = DatadogAPIClient::V2::MetricTagConfigurationUpdateRequest.new({data: DatadogAPIClient::V2::MetricTagConfigurationUpdateData.new({id: 'test.metric.latency', type: DatadogAPIClient::V2::MetricTagConfigurationType::MANAGE_TAGS})}) # MetricTagConfigurationUpdateRequest | begin # Update a tag configuration @@ -465,10 +458,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **metric_name** | **String** | The name of the metric. | | -| **body** | [**MetricTagConfigurationUpdateRequest**](MetricTagConfigurationUpdateRequest.md) | | | +| Name | Type | Description | Notes | +| --------------- | --------------------------------------------------------------------------------- | ----------------------- | ----- | +| **metric_name** | **String** | The name of the metric. | | +| **body** | [**MetricTagConfigurationUpdateRequest**](MetricTagConfigurationUpdateRequest.md) | | | ### Return type @@ -482,4 +475,3 @@ end - **Content-Type**: application/json - **Accept**: application/json - diff --git a/docs/v2/MetricsAndMetricTagConfigurations.md b/docs/v2/MetricsAndMetricTagConfigurations.md index ef69545b5243..08b73f132ebb 100644 --- a/docs/v2/MetricsAndMetricTagConfigurations.md +++ b/docs/v2/MetricsAndMetricTagConfigurations.md @@ -37,8 +37,8 @@ DatadogAPIClient::V2::MetricsAndMetricTagConfigurations.build(data_that_doesnt_m #### Parameters -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| -------- | --------- | -------------------------------------------------- | | **data** | **Mixed** | data to be matched against the list of oneOf items | #### Return type @@ -46,4 +46,3 @@ DatadogAPIClient::V2::MetricsAndMetricTagConfigurations.build(data_that_doesnt_m - `Metric` - `MetricTagConfiguration` - `nil` (if no type matches) - diff --git a/docs/v2/MetricsAndMetricTagConfigurationsResponse.md b/docs/v2/MetricsAndMetricTagConfigurationsResponse.md index 45bc94679375..39bd80dce9b9 100644 --- a/docs/v2/MetricsAndMetricTagConfigurationsResponse.md +++ b/docs/v2/MetricsAndMetricTagConfigurationsResponse.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| -------- | ------------------------------------------------------------------------------------------ | ----------------------------------------------- | ---------- | | **data** | [**Array<MetricsAndMetricTagConfigurations>**](MetricsAndMetricTagConfigurations.md) | Array of metrics and metric tag configurations. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::MetricsAndMetricTagConfigurationsResponse.new( data: null ) ``` - diff --git a/docs/v2/Organization.md b/docs/v2/Organization.md index c09430896b21..bc0389d46f53 100644 --- a/docs/v2/Organization.md +++ b/docs/v2/Organization.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**OrganizationAttributes**](OrganizationAttributes.md) | | [optional] | -| **id** | **String** | ID of the organization. | [optional] | -| **type** | [**OrganizationsType**](OrganizationsType.md) | | [default to 'orgs'] | +| Name | Type | Description | Notes | +| -------------- | ------------------------------------------------------- | ----------------------- | --------------------------- | +| **attributes** | [**OrganizationAttributes**](OrganizationAttributes.md) | | [optional] | +| **id** | **String** | ID of the organization. | [optional] | +| **type** | [**OrganizationsType**](OrganizationsType.md) | | [default to 'orgs'] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V2::Organization.new( type: null ) ``` - diff --git a/docs/v2/OrganizationAttributes.md b/docs/v2/OrganizationAttributes.md index bd15db635db9..8122bbbed841 100644 --- a/docs/v2/OrganizationAttributes.md +++ b/docs/v2/OrganizationAttributes.md @@ -2,16 +2,16 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **created_at** | **Time** | Creation time of the organization. | [optional] | -| **description** | **String** | Description of the organization. | [optional] | -| **disabled** | **Boolean** | Whether or not the organization is disabled. | [optional] | -| **modified_at** | **Time** | Time of last organization modification. | [optional] | -| **name** | **String** | Name of the organization. | [optional] | -| **public_id** | **String** | Public ID of the organization. | [optional] | -| **sharing** | **String** | Sharing type of the organization. | [optional] | -| **url** | **String** | URL of the site that this organization exists at. | [optional] | +| Name | Type | Description | Notes | +| --------------- | ----------- | ------------------------------------------------- | ---------- | +| **created_at** | **Time** | Creation time of the organization. | [optional] | +| **description** | **String** | Description of the organization. | [optional] | +| **disabled** | **Boolean** | Whether or not the organization is disabled. | [optional] | +| **modified_at** | **Time** | Time of last organization modification. | [optional] | +| **name** | **String** | Name of the organization. | [optional] | +| **public_id** | **String** | Public ID of the organization. | [optional] | +| **sharing** | **String** | Sharing type of the organization. | [optional] | +| **url** | **String** | URL of the site that this organization exists at. | [optional] | ## Example @@ -29,4 +29,3 @@ instance = DatadogAPIClient::V2::OrganizationAttributes.new( url: null ) ``` - diff --git a/docs/v2/OrganizationsType.md b/docs/v2/OrganizationsType.md index 6fcf7da8bf15..e6a6873f7b38 100644 --- a/docs/v2/OrganizationsType.md +++ b/docs/v2/OrganizationsType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::OrganizationsType.new() ``` - diff --git a/docs/v2/Pagination.md b/docs/v2/Pagination.md index d8ea695f1115..e053eb1e3401 100644 --- a/docs/v2/Pagination.md +++ b/docs/v2/Pagination.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **total_count** | **Integer** | Total count. | [optional] | +| Name | Type | Description | Notes | +| ------------------------ | ----------- | ---------------------------------------------- | ---------- | +| **total_count** | **Integer** | Total count. | [optional] | | **total_filtered_count** | **Integer** | Total count of elements matched by the filter. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::Pagination.new( total_filtered_count: null ) ``` - diff --git a/docs/v2/PartialAPIKey.md b/docs/v2/PartialAPIKey.md index 16abd68031e8..06c44710db79 100644 --- a/docs/v2/PartialAPIKey.md +++ b/docs/v2/PartialAPIKey.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**PartialAPIKeyAttributes**](PartialAPIKeyAttributes.md) | | [optional] | -| **id** | **String** | ID of the API key. | [optional] | -| **relationships** | [**APIKeyRelationships**](APIKeyRelationships.md) | | [optional] | -| **type** | [**APIKeysType**](APIKeysType.md) | | [optional][default to 'api_keys'] | +| Name | Type | Description | Notes | +| ----------------- | --------------------------------------------------------- | ------------------ | ----------------------------------------- | +| **attributes** | [**PartialAPIKeyAttributes**](PartialAPIKeyAttributes.md) | | [optional] | +| **id** | **String** | ID of the API key. | [optional] | +| **relationships** | [**APIKeyRelationships**](APIKeyRelationships.md) | | [optional] | +| **type** | [**APIKeysType**](APIKeysType.md) | | [optional][default to 'api_keys'] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V2::PartialAPIKey.new( type: null ) ``` - diff --git a/docs/v2/PartialAPIKeyAttributes.md b/docs/v2/PartialAPIKeyAttributes.md index bb7bf31aa8ea..f1218ddcd4fe 100644 --- a/docs/v2/PartialAPIKeyAttributes.md +++ b/docs/v2/PartialAPIKeyAttributes.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **created_at** | **String** | Creation date of the API key. | [optional][readonly] | -| **last4** | **String** | The last four characters of the API key. | [optional][readonly] | -| **modified_at** | **String** | Date the API key was last modified. | [optional][readonly] | -| **name** | **String** | Name of the API key. | [optional] | +| Name | Type | Description | Notes | +| --------------- | ---------- | ---------------------------------------- | -------------------- | +| **created_at** | **String** | Creation date of the API key. | [optional][readonly] | +| **last4** | **String** | The last four characters of the API key. | [optional][readonly] | +| **modified_at** | **String** | Date the API key was last modified. | [optional][readonly] | +| **name** | **String** | Name of the API key. | [optional] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V2::PartialAPIKeyAttributes.new( name: API Key for submitting metrics ) ``` - diff --git a/docs/v2/PartialApplicationKey.md b/docs/v2/PartialApplicationKey.md index c1d3cf4c84a8..7f609ed1ad0a 100644 --- a/docs/v2/PartialApplicationKey.md +++ b/docs/v2/PartialApplicationKey.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**PartialApplicationKeyAttributes**](PartialApplicationKeyAttributes.md) | | [optional] | -| **id** | **String** | ID of the application key. | [optional] | -| **relationships** | [**ApplicationKeyRelationships**](ApplicationKeyRelationships.md) | | [optional] | -| **type** | [**ApplicationKeysType**](ApplicationKeysType.md) | | [optional][default to 'application_keys'] | +| Name | Type | Description | Notes | +| ----------------- | ------------------------------------------------------------------------- | -------------------------- | ------------------------------------------------- | +| **attributes** | [**PartialApplicationKeyAttributes**](PartialApplicationKeyAttributes.md) | | [optional] | +| **id** | **String** | ID of the application key. | [optional] | +| **relationships** | [**ApplicationKeyRelationships**](ApplicationKeyRelationships.md) | | [optional] | +| **type** | [**ApplicationKeysType**](ApplicationKeysType.md) | | [optional][default to 'application_keys'] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V2::PartialApplicationKey.new( type: null ) ``` - diff --git a/docs/v2/PartialApplicationKeyAttributes.md b/docs/v2/PartialApplicationKeyAttributes.md index a517077a43a1..1a969ea19b5b 100644 --- a/docs/v2/PartialApplicationKeyAttributes.md +++ b/docs/v2/PartialApplicationKeyAttributes.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **created_at** | **String** | Creation date of the application key. | [optional][readonly] | -| **last4** | **String** | The last four characters of the application key. | [optional][readonly] | -| **name** | **String** | Name of the application key. | [optional] | +| Name | Type | Description | Notes | +| -------------- | ---------- | ------------------------------------------------ | -------------------- | +| **created_at** | **String** | Creation date of the application key. | [optional][readonly] | +| **last4** | **String** | The last four characters of the application key. | [optional][readonly] | +| **name** | **String** | Name of the application key. | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V2::PartialApplicationKeyAttributes.new( name: Application Key for submitting metrics ) ``` - diff --git a/docs/v2/PartialApplicationKeyResponse.md b/docs/v2/PartialApplicationKeyResponse.md index 83310cf65f84..43c945cbeec7 100644 --- a/docs/v2/PartialApplicationKeyResponse.md +++ b/docs/v2/PartialApplicationKeyResponse.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**PartialApplicationKey**](PartialApplicationKey.md) | | [optional] | +| Name | Type | Description | Notes | +| ------------ | -------------------------------------------------------------------------------------------- | ------------------------------------------------ | ---------- | +| **data** | [**PartialApplicationKey**](PartialApplicationKey.md) | | [optional] | | **included** | [**Array<ApplicationKeyResponseIncludedItem>**](ApplicationKeyResponseIncludedItem.md) | Array of objects related to the application key. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::PartialApplicationKeyResponse.new( included: null ) ``` - diff --git a/docs/v2/Permission.md b/docs/v2/Permission.md index 0602a2b9de24..ed8c02e60c05 100644 --- a/docs/v2/Permission.md +++ b/docs/v2/Permission.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**PermissionAttributes**](PermissionAttributes.md) | | [optional] | -| **id** | **String** | ID of the permission. | [optional] | -| **type** | [**PermissionsType**](PermissionsType.md) | | [default to 'permissions'] | +| Name | Type | Description | Notes | +| -------------- | --------------------------------------------------- | --------------------- | ---------------------------------- | +| **attributes** | [**PermissionAttributes**](PermissionAttributes.md) | | [optional] | +| **id** | **String** | ID of the permission. | [optional] | +| **type** | [**PermissionsType**](PermissionsType.md) | | [default to 'permissions'] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V2::Permission.new( type: null ) ``` - diff --git a/docs/v2/PermissionAttributes.md b/docs/v2/PermissionAttributes.md index 136e965c4400..c7fe14a03f40 100644 --- a/docs/v2/PermissionAttributes.md +++ b/docs/v2/PermissionAttributes.md @@ -2,15 +2,15 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **created** | **Time** | Creation time of the permission. | [optional] | -| **description** | **String** | Description of the permission. | [optional] | -| **display_name** | **String** | Displayed name for the permission. | [optional] | -| **display_type** | **String** | Display type. | [optional] | -| **group_name** | **String** | Name of the permission group. | [optional] | -| **name** | **String** | Name of the permission. | [optional] | -| **restricted** | **Boolean** | Whether or not the permission is restricted. | [optional] | +| Name | Type | Description | Notes | +| ---------------- | ----------- | -------------------------------------------- | ---------- | +| **created** | **Time** | Creation time of the permission. | [optional] | +| **description** | **String** | Description of the permission. | [optional] | +| **display_name** | **String** | Displayed name for the permission. | [optional] | +| **display_type** | **String** | Display type. | [optional] | +| **group_name** | **String** | Name of the permission group. | [optional] | +| **name** | **String** | Name of the permission. | [optional] | +| **restricted** | **Boolean** | Whether or not the permission is restricted. | [optional] | ## Example @@ -27,4 +27,3 @@ instance = DatadogAPIClient::V2::PermissionAttributes.new( restricted: null ) ``` - diff --git a/docs/v2/PermissionsResponse.md b/docs/v2/PermissionsResponse.md index 1971284e59e4..064600a05502 100644 --- a/docs/v2/PermissionsResponse.md +++ b/docs/v2/PermissionsResponse.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| -------- | -------------------------------------------- | --------------------- | ---------- | | **data** | [**Array<Permission>**](Permission.md) | Array of permissions. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::PermissionsResponse.new( data: null ) ``` - diff --git a/docs/v2/PermissionsType.md b/docs/v2/PermissionsType.md index a9aa6dc6c20d..c7e6d61bffba 100644 --- a/docs/v2/PermissionsType.md +++ b/docs/v2/PermissionsType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::PermissionsType.new() ``` - diff --git a/docs/v2/ProcessSummariesMeta.md b/docs/v2/ProcessSummariesMeta.md index ac306c5dd861..848780ffea5e 100644 --- a/docs/v2/ProcessSummariesMeta.md +++ b/docs/v2/ProcessSummariesMeta.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **page** | [**ProcessSummariesMetaPage**](ProcessSummariesMetaPage.md) | | [optional] | +| Name | Type | Description | Notes | +| -------- | ----------------------------------------------------------- | ----------- | ---------- | +| **page** | [**ProcessSummariesMetaPage**](ProcessSummariesMetaPage.md) | | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::ProcessSummariesMeta.new( page: null ) ``` - diff --git a/docs/v2/ProcessSummariesMetaPage.md b/docs/v2/ProcessSummariesMetaPage.md index fddc01d111c7..9f951f26ec7b 100644 --- a/docs/v2/ProcessSummariesMetaPage.md +++ b/docs/v2/ProcessSummariesMetaPage.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **after** | **String** | The cursor used to get the next results, if any. To make the next request, use the same parameters with the addition of the `page[cursor]`. | [optional] | -| **size** | **Integer** | Number of results returned. | [optional] | +| Name | Type | Description | Notes | +| --------- | ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **after** | **String** | The cursor used to get the next results, if any. To make the next request, use the same parameters with the addition of the `page[cursor]`. | [optional] | +| **size** | **Integer** | Number of results returned. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::ProcessSummariesMetaPage.new( size: null ) ``` - diff --git a/docs/v2/ProcessSummariesResponse.md b/docs/v2/ProcessSummariesResponse.md index 9abf0c8a68cc..c462bb76e139 100644 --- a/docs/v2/ProcessSummariesResponse.md +++ b/docs/v2/ProcessSummariesResponse.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| -------- | ---------------------------------------------------- | --------------------------------- | ---------- | | **data** | [**Array<ProcessSummary>**](ProcessSummary.md) | Array of process summary objects. | [optional] | -| **meta** | [**ProcessSummariesMeta**](ProcessSummariesMeta.md) | | [optional] | +| **meta** | [**ProcessSummariesMeta**](ProcessSummariesMeta.md) | | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::ProcessSummariesResponse.new( meta: null ) ``` - diff --git a/docs/v2/ProcessSummary.md b/docs/v2/ProcessSummary.md index c36d9386fba3..de524b4f6403 100644 --- a/docs/v2/ProcessSummary.md +++ b/docs/v2/ProcessSummary.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**ProcessSummaryAttributes**](ProcessSummaryAttributes.md) | | [optional] | -| **id** | **String** | Process ID. | [optional] | -| **type** | [**ProcessSummaryType**](ProcessSummaryType.md) | | [optional][default to 'process'] | +| Name | Type | Description | Notes | +| -------------- | ----------------------------------------------------------- | ----------- | ---------------------------------------- | +| **attributes** | [**ProcessSummaryAttributes**](ProcessSummaryAttributes.md) | | [optional] | +| **id** | **String** | Process ID. | [optional] | +| **type** | [**ProcessSummaryType**](ProcessSummaryType.md) | | [optional][default to 'process'] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V2::ProcessSummary.new( type: null ) ``` - diff --git a/docs/v2/ProcessSummaryAttributes.md b/docs/v2/ProcessSummaryAttributes.md index b891afee6e77..42f4f6dbbf7e 100644 --- a/docs/v2/ProcessSummaryAttributes.md +++ b/docs/v2/ProcessSummaryAttributes.md @@ -2,16 +2,16 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **cmdline** | **String** | Process command line. | [optional] | -| **host** | **String** | Host running the process. | [optional] | -| **pid** | **Integer** | Process ID. | [optional] | -| **ppid** | **Integer** | Parent process ID. | [optional] | -| **start** | **String** | Time the process was started. | [optional] | -| **tags** | **Array<String>** | List of tags associated with the process. | [optional] | -| **timestamp** | **String** | Time the process was seen. | [optional] | -| **user** | **String** | Process owner. | [optional] | +| Name | Type | Description | Notes | +| ------------- | ----------------------- | ----------------------------------------- | ---------- | +| **cmdline** | **String** | Process command line. | [optional] | +| **host** | **String** | Host running the process. | [optional] | +| **pid** | **Integer** | Process ID. | [optional] | +| **ppid** | **Integer** | Parent process ID. | [optional] | +| **start** | **String** | Time the process was started. | [optional] | +| **tags** | **Array<String>** | List of tags associated with the process. | [optional] | +| **timestamp** | **String** | Time the process was seen. | [optional] | +| **user** | **String** | Process owner. | [optional] | ## Example @@ -29,4 +29,3 @@ instance = DatadogAPIClient::V2::ProcessSummaryAttributes.new( user: null ) ``` - diff --git a/docs/v2/ProcessSummaryType.md b/docs/v2/ProcessSummaryType.md index b50366a0ca0e..c83ecb88a648 100644 --- a/docs/v2/ProcessSummaryType.md +++ b/docs/v2/ProcessSummaryType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::ProcessSummaryType.new() ``` - diff --git a/docs/v2/ProcessesAPI.md b/docs/v2/ProcessesAPI.md index 7b0ed50971c9..c08886a93a2c 100644 --- a/docs/v2/ProcessesAPI.md +++ b/docs/v2/ProcessesAPI.md @@ -2,11 +2,10 @@ All URIs are relative to *https://api.datadoghq.com* -| Method | HTTP request | Description | -| ------ | ------------ | ----------- | +| Method | HTTP request | Description | +| ---------------------------------------------------- | ------------------------- | ----------------- | | [**list_processes**](ProcessesAPI.md#list_processes) | **GET** /api/v2/processes | Get all processes | - ## list_processes > list_processes(opts) @@ -56,14 +55,14 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **search** | **String** | String to search processes by. | [optional] | -| **tags** | **String** | Comma-separated list of tags to filter processes by. | [optional] | -| **from** | **Integer** | Unix timestamp (number of seconds since epoch) of the start of the query window. If not provided, the start of the query window will be 15 minutes before the `to` timestamp. If neither `from` nor `to` are provided, the query window will be `[now - 15m, now]`. | [optional] | -| **to** | **Integer** | Unix timestamp (number of seconds since epoch) of the end of the query window. If not provided, the end of the query window will be 15 minutes after the `from` timestamp. If neither `from` nor `to` are provided, the query window will be `[now - 15m, now]`. | [optional] | -| **page_limit** | **Integer** | Maximum number of results returned. | [optional][default to 1000] | -| **page_cursor** | **String** | String to query the next page of results. This key is provided with each valid response from the API in `meta.page.after`. | [optional] | +| Name | Type | Description | Notes | +| --------------- | ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- | +| **search** | **String** | String to search processes by. | [optional] | +| **tags** | **String** | Comma-separated list of tags to filter processes by. | [optional] | +| **from** | **Integer** | Unix timestamp (number of seconds since epoch) of the start of the query window. If not provided, the start of the query window will be 15 minutes before the `to` timestamp. If neither `from` nor `to` are provided, the query window will be `[now - 15m, now]`. | [optional] | +| **to** | **Integer** | Unix timestamp (number of seconds since epoch) of the end of the query window. If not provided, the end of the query window will be 15 minutes after the `from` timestamp. If neither `from` nor `to` are provided, the query window will be `[now - 15m, now]`. | [optional] | +| **page_limit** | **Integer** | Maximum number of results returned. | [optional][default to 1000] | +| **page_cursor** | **String** | String to query the next page of results. This key is provided with each valid response from the API in `meta.page.after`. | [optional] | ### Return type @@ -77,4 +76,3 @@ end - **Content-Type**: Not defined - **Accept**: application/json - diff --git a/docs/v2/QuerySortOrder.md b/docs/v2/QuerySortOrder.md index f0780db999d7..4beec4982ebf 100644 --- a/docs/v2/QuerySortOrder.md +++ b/docs/v2/QuerySortOrder.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::QuerySortOrder.new() ``` - diff --git a/docs/v2/README.md b/docs/v2/README.md index 7d3a476e9385..9240958cb415 100644 --- a/docs/v2/README.md +++ b/docs/v2/README.md @@ -30,450 +30,446 @@ end All URIs are relative to *https://api.datadoghq.com* -Class | Method | HTTP request | Description ------------- | ------------- | ------------- | ------------- -*DatadogAPIClient::V2::DashboardListsAPI* | [**create_dashboard_list_items**](DashboardListsAPI.md#create_dashboard_list_items) | **POST** /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards | Add Items to a Dashboard List -*DatadogAPIClient::V2::DashboardListsAPI* | [**delete_dashboard_list_items**](DashboardListsAPI.md#delete_dashboard_list_items) | **DELETE** /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards | Delete items from a dashboard list -*DatadogAPIClient::V2::DashboardListsAPI* | [**get_dashboard_list_items**](DashboardListsAPI.md#get_dashboard_list_items) | **GET** /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards | Get items of a Dashboard List -*DatadogAPIClient::V2::DashboardListsAPI* | [**update_dashboard_list_items**](DashboardListsAPI.md#update_dashboard_list_items) | **PUT** /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards | Update items of a dashboard list -*DatadogAPIClient::V2::IncidentServicesAPI* | [**create_incident_service**](IncidentServicesAPI.md#create_incident_service) | **POST** /api/v2/services | Create a new incident service -*DatadogAPIClient::V2::IncidentServicesAPI* | [**delete_incident_service**](IncidentServicesAPI.md#delete_incident_service) | **DELETE** /api/v2/services/{service_id} | Delete an existing incident service -*DatadogAPIClient::V2::IncidentServicesAPI* | [**get_incident_service**](IncidentServicesAPI.md#get_incident_service) | **GET** /api/v2/services/{service_id} | Get details of an incident service -*DatadogAPIClient::V2::IncidentServicesAPI* | [**list_incident_services**](IncidentServicesAPI.md#list_incident_services) | **GET** /api/v2/services | Get a list of all incident services -*DatadogAPIClient::V2::IncidentServicesAPI* | [**update_incident_service**](IncidentServicesAPI.md#update_incident_service) | **PATCH** /api/v2/services/{service_id} | Update an existing incident service -*DatadogAPIClient::V2::IncidentTeamsAPI* | [**create_incident_team**](IncidentTeamsAPI.md#create_incident_team) | **POST** /api/v2/teams | Create a new incident team -*DatadogAPIClient::V2::IncidentTeamsAPI* | [**delete_incident_team**](IncidentTeamsAPI.md#delete_incident_team) | **DELETE** /api/v2/teams/{team_id} | Delete an existing incident team -*DatadogAPIClient::V2::IncidentTeamsAPI* | [**get_incident_team**](IncidentTeamsAPI.md#get_incident_team) | **GET** /api/v2/teams/{team_id} | Get details of an incident team -*DatadogAPIClient::V2::IncidentTeamsAPI* | [**list_incident_teams**](IncidentTeamsAPI.md#list_incident_teams) | **GET** /api/v2/teams | Get a list of all incident teams -*DatadogAPIClient::V2::IncidentTeamsAPI* | [**update_incident_team**](IncidentTeamsAPI.md#update_incident_team) | **PATCH** /api/v2/teams/{team_id} | Update an existing incident team -*DatadogAPIClient::V2::IncidentsAPI* | [**create_incident**](IncidentsAPI.md#create_incident) | **POST** /api/v2/incidents | Create an incident -*DatadogAPIClient::V2::IncidentsAPI* | [**delete_incident**](IncidentsAPI.md#delete_incident) | **DELETE** /api/v2/incidents/{incident_id} | Delete an existing incident -*DatadogAPIClient::V2::IncidentsAPI* | [**get_incident**](IncidentsAPI.md#get_incident) | **GET** /api/v2/incidents/{incident_id} | Get the details of an incident -*DatadogAPIClient::V2::IncidentsAPI* | [**list_incidents**](IncidentsAPI.md#list_incidents) | **GET** /api/v2/incidents | Get a list of incidents -*DatadogAPIClient::V2::IncidentsAPI* | [**update_incident**](IncidentsAPI.md#update_incident) | **PATCH** /api/v2/incidents/{incident_id} | Update an existing incident -*DatadogAPIClient::V2::KeyManagementAPI* | [**create_api_key**](KeyManagementAPI.md#create_api_key) | **POST** /api/v2/api_keys | Create an API key -*DatadogAPIClient::V2::KeyManagementAPI* | [**create_current_user_application_key**](KeyManagementAPI.md#create_current_user_application_key) | **POST** /api/v2/current_user/application_keys | Create an application key for current user -*DatadogAPIClient::V2::KeyManagementAPI* | [**delete_api_key**](KeyManagementAPI.md#delete_api_key) | **DELETE** /api/v2/api_keys/{api_key_id} | Delete an API key -*DatadogAPIClient::V2::KeyManagementAPI* | [**delete_application_key**](KeyManagementAPI.md#delete_application_key) | **DELETE** /api/v2/application_keys/{app_key_id} | Delete an application key -*DatadogAPIClient::V2::KeyManagementAPI* | [**delete_current_user_application_key**](KeyManagementAPI.md#delete_current_user_application_key) | **DELETE** /api/v2/current_user/application_keys/{app_key_id} | Delete an application key owned by current user -*DatadogAPIClient::V2::KeyManagementAPI* | [**get_api_key**](KeyManagementAPI.md#get_api_key) | **GET** /api/v2/api_keys/{api_key_id} | Get API key -*DatadogAPIClient::V2::KeyManagementAPI* | [**get_application_key**](KeyManagementAPI.md#get_application_key) | **GET** /api/v2/application_keys/{app_key_id} | Get an application key -*DatadogAPIClient::V2::KeyManagementAPI* | [**get_current_user_application_key**](KeyManagementAPI.md#get_current_user_application_key) | **GET** /api/v2/current_user/application_keys/{app_key_id} | Get one application key owned by current user -*DatadogAPIClient::V2::KeyManagementAPI* | [**list_api_keys**](KeyManagementAPI.md#list_api_keys) | **GET** /api/v2/api_keys | Get all API keys -*DatadogAPIClient::V2::KeyManagementAPI* | [**list_application_keys**](KeyManagementAPI.md#list_application_keys) | **GET** /api/v2/application_keys | Get all application keys -*DatadogAPIClient::V2::KeyManagementAPI* | [**list_current_user_application_keys**](KeyManagementAPI.md#list_current_user_application_keys) | **GET** /api/v2/current_user/application_keys | Get all application keys owned by current user -*DatadogAPIClient::V2::KeyManagementAPI* | [**update_api_key**](KeyManagementAPI.md#update_api_key) | **PATCH** /api/v2/api_keys/{api_key_id} | Edit an API key -*DatadogAPIClient::V2::KeyManagementAPI* | [**update_application_key**](KeyManagementAPI.md#update_application_key) | **PATCH** /api/v2/application_keys/{app_key_id} | Edit an application key -*DatadogAPIClient::V2::KeyManagementAPI* | [**update_current_user_application_key**](KeyManagementAPI.md#update_current_user_application_key) | **PATCH** /api/v2/current_user/application_keys/{app_key_id} | Edit an application key owned by current user -*DatadogAPIClient::V2::LogsAPI* | [**aggregate_logs**](LogsAPI.md#aggregate_logs) | **POST** /api/v2/logs/analytics/aggregate | Aggregate events -*DatadogAPIClient::V2::LogsAPI* | [**list_logs**](LogsAPI.md#list_logs) | **POST** /api/v2/logs/events/search | Search logs -*DatadogAPIClient::V2::LogsAPI* | [**list_logs_get**](LogsAPI.md#list_logs_get) | **GET** /api/v2/logs/events | Get a list of logs -*DatadogAPIClient::V2::LogsArchivesAPI* | [**add_read_role_to_archive**](LogsArchivesAPI.md#add_read_role_to_archive) | **POST** /api/v2/logs/config/archives/{archive_id}/readers | Grant role to an archive -*DatadogAPIClient::V2::LogsArchivesAPI* | [**create_logs_archive**](LogsArchivesAPI.md#create_logs_archive) | **POST** /api/v2/logs/config/archives | Create an archive -*DatadogAPIClient::V2::LogsArchivesAPI* | [**delete_logs_archive**](LogsArchivesAPI.md#delete_logs_archive) | **DELETE** /api/v2/logs/config/archives/{archive_id} | Delete an archive -*DatadogAPIClient::V2::LogsArchivesAPI* | [**get_logs_archive**](LogsArchivesAPI.md#get_logs_archive) | **GET** /api/v2/logs/config/archives/{archive_id} | Get an archive -*DatadogAPIClient::V2::LogsArchivesAPI* | [**get_logs_archive_order**](LogsArchivesAPI.md#get_logs_archive_order) | **GET** /api/v2/logs/config/archive-order | Get archive order -*DatadogAPIClient::V2::LogsArchivesAPI* | [**list_archive_read_roles**](LogsArchivesAPI.md#list_archive_read_roles) | **GET** /api/v2/logs/config/archives/{archive_id}/readers | List read roles for an archive -*DatadogAPIClient::V2::LogsArchivesAPI* | [**list_logs_archives**](LogsArchivesAPI.md#list_logs_archives) | **GET** /api/v2/logs/config/archives | Get all archives -*DatadogAPIClient::V2::LogsArchivesAPI* | [**remove_role_from_archive**](LogsArchivesAPI.md#remove_role_from_archive) | **DELETE** /api/v2/logs/config/archives/{archive_id}/readers | Revoke role from an archive -*DatadogAPIClient::V2::LogsArchivesAPI* | [**update_logs_archive**](LogsArchivesAPI.md#update_logs_archive) | **PUT** /api/v2/logs/config/archives/{archive_id} | Update an archive -*DatadogAPIClient::V2::LogsArchivesAPI* | [**update_logs_archive_order**](LogsArchivesAPI.md#update_logs_archive_order) | **PUT** /api/v2/logs/config/archive-order | Update archive order -*DatadogAPIClient::V2::LogsMetricsAPI* | [**create_logs_metric**](LogsMetricsAPI.md#create_logs_metric) | **POST** /api/v2/logs/config/metrics | Create a log-based metric -*DatadogAPIClient::V2::LogsMetricsAPI* | [**delete_logs_metric**](LogsMetricsAPI.md#delete_logs_metric) | **DELETE** /api/v2/logs/config/metrics/{metric_id} | Delete a log-based metric -*DatadogAPIClient::V2::LogsMetricsAPI* | [**get_logs_metric**](LogsMetricsAPI.md#get_logs_metric) | **GET** /api/v2/logs/config/metrics/{metric_id} | Get a log-based metric -*DatadogAPIClient::V2::LogsMetricsAPI* | [**list_logs_metrics**](LogsMetricsAPI.md#list_logs_metrics) | **GET** /api/v2/logs/config/metrics | Get all log-based metrics -*DatadogAPIClient::V2::LogsMetricsAPI* | [**update_logs_metric**](LogsMetricsAPI.md#update_logs_metric) | **PATCH** /api/v2/logs/config/metrics/{metric_id} | Update a log-based metric -*DatadogAPIClient::V2::MetricsAPI* | [**create_tag_configuration**](MetricsAPI.md#create_tag_configuration) | **POST** /api/v2/metrics/{metric_name}/tags | Create a tag configuration -*DatadogAPIClient::V2::MetricsAPI* | [**delete_tag_configuration**](MetricsAPI.md#delete_tag_configuration) | **DELETE** /api/v2/metrics/{metric_name}/tags | Delete a tag configuration -*DatadogAPIClient::V2::MetricsAPI* | [**list_tag_configuration_by_name**](MetricsAPI.md#list_tag_configuration_by_name) | **GET** /api/v2/metrics/{metric_name}/tags | List tag configuration by name -*DatadogAPIClient::V2::MetricsAPI* | [**list_tag_configurations**](MetricsAPI.md#list_tag_configurations) | **GET** /api/v2/metrics | List tag configurations -*DatadogAPIClient::V2::MetricsAPI* | [**list_tags_by_metric_name**](MetricsAPI.md#list_tags_by_metric_name) | **GET** /api/v2/metrics/{metric_name}/all-tags | List tags by metric name -*DatadogAPIClient::V2::MetricsAPI* | [**list_volumes_by_metric_name**](MetricsAPI.md#list_volumes_by_metric_name) | **GET** /api/v2/metrics/{metric_name}/volumes | List distinct metric volumes by metric name -*DatadogAPIClient::V2::MetricsAPI* | [**update_tag_configuration**](MetricsAPI.md#update_tag_configuration) | **PATCH** /api/v2/metrics/{metric_name}/tags | Update a tag configuration -*DatadogAPIClient::V2::ProcessesAPI* | [**list_processes**](ProcessesAPI.md#list_processes) | **GET** /api/v2/processes | Get all processes -*DatadogAPIClient::V2::RolesAPI* | [**add_permission_to_role**](RolesAPI.md#add_permission_to_role) | **POST** /api/v2/roles/{role_id}/permissions | Grant permission to a role -*DatadogAPIClient::V2::RolesAPI* | [**add_user_to_role**](RolesAPI.md#add_user_to_role) | **POST** /api/v2/roles/{role_id}/users | Add a user to a role -*DatadogAPIClient::V2::RolesAPI* | [**create_role**](RolesAPI.md#create_role) | **POST** /api/v2/roles | Create role -*DatadogAPIClient::V2::RolesAPI* | [**delete_role**](RolesAPI.md#delete_role) | **DELETE** /api/v2/roles/{role_id} | Delete role -*DatadogAPIClient::V2::RolesAPI* | [**get_role**](RolesAPI.md#get_role) | **GET** /api/v2/roles/{role_id} | Get a role -*DatadogAPIClient::V2::RolesAPI* | [**list_permissions**](RolesAPI.md#list_permissions) | **GET** /api/v2/permissions | List permissions -*DatadogAPIClient::V2::RolesAPI* | [**list_role_permissions**](RolesAPI.md#list_role_permissions) | **GET** /api/v2/roles/{role_id}/permissions | List permissions for a role -*DatadogAPIClient::V2::RolesAPI* | [**list_role_users**](RolesAPI.md#list_role_users) | **GET** /api/v2/roles/{role_id}/users | Get all users of a role -*DatadogAPIClient::V2::RolesAPI* | [**list_roles**](RolesAPI.md#list_roles) | **GET** /api/v2/roles | List roles -*DatadogAPIClient::V2::RolesAPI* | [**remove_permission_from_role**](RolesAPI.md#remove_permission_from_role) | **DELETE** /api/v2/roles/{role_id}/permissions | Revoke permission -*DatadogAPIClient::V2::RolesAPI* | [**remove_user_from_role**](RolesAPI.md#remove_user_from_role) | **DELETE** /api/v2/roles/{role_id}/users | Remove a user from a role -*DatadogAPIClient::V2::RolesAPI* | [**update_role**](RolesAPI.md#update_role) | **PATCH** /api/v2/roles/{role_id} | Update a role -*DatadogAPIClient::V2::SecurityMonitoringAPI* | [**create_security_filter**](SecurityMonitoringAPI.md#create_security_filter) | **POST** /api/v2/security_monitoring/configuration/security_filters | Create a security filter -*DatadogAPIClient::V2::SecurityMonitoringAPI* | [**create_security_monitoring_rule**](SecurityMonitoringAPI.md#create_security_monitoring_rule) | **POST** /api/v2/security_monitoring/rules | Create a detection rule -*DatadogAPIClient::V2::SecurityMonitoringAPI* | [**delete_security_filter**](SecurityMonitoringAPI.md#delete_security_filter) | **DELETE** /api/v2/security_monitoring/configuration/security_filters/{security_filter_id} | Delete a security filter -*DatadogAPIClient::V2::SecurityMonitoringAPI* | [**delete_security_monitoring_rule**](SecurityMonitoringAPI.md#delete_security_monitoring_rule) | **DELETE** /api/v2/security_monitoring/rules/{rule_id} | Delete an existing rule -*DatadogAPIClient::V2::SecurityMonitoringAPI* | [**get_security_filter**](SecurityMonitoringAPI.md#get_security_filter) | **GET** /api/v2/security_monitoring/configuration/security_filters/{security_filter_id} | Get a security filter -*DatadogAPIClient::V2::SecurityMonitoringAPI* | [**get_security_monitoring_rule**](SecurityMonitoringAPI.md#get_security_monitoring_rule) | **GET** /api/v2/security_monitoring/rules/{rule_id} | Get a rule's details -*DatadogAPIClient::V2::SecurityMonitoringAPI* | [**list_security_filters**](SecurityMonitoringAPI.md#list_security_filters) | **GET** /api/v2/security_monitoring/configuration/security_filters | Get all security filters -*DatadogAPIClient::V2::SecurityMonitoringAPI* | [**list_security_monitoring_rules**](SecurityMonitoringAPI.md#list_security_monitoring_rules) | **GET** /api/v2/security_monitoring/rules | List rules -*DatadogAPIClient::V2::SecurityMonitoringAPI* | [**list_security_monitoring_signals**](SecurityMonitoringAPI.md#list_security_monitoring_signals) | **GET** /api/v2/security_monitoring/signals | Get a quick list of security signals -*DatadogAPIClient::V2::SecurityMonitoringAPI* | [**search_security_monitoring_signals**](SecurityMonitoringAPI.md#search_security_monitoring_signals) | **POST** /api/v2/security_monitoring/signals/search | Get a list of security signals -*DatadogAPIClient::V2::SecurityMonitoringAPI* | [**update_security_filter**](SecurityMonitoringAPI.md#update_security_filter) | **PATCH** /api/v2/security_monitoring/configuration/security_filters/{security_filter_id} | Update a security filter -*DatadogAPIClient::V2::SecurityMonitoringAPI* | [**update_security_monitoring_rule**](SecurityMonitoringAPI.md#update_security_monitoring_rule) | **PUT** /api/v2/security_monitoring/rules/{rule_id} | Update an existing rule -*DatadogAPIClient::V2::ServiceAccountsAPI* | [**create_service_account_application_key**](ServiceAccountsAPI.md#create_service_account_application_key) | **POST** /api/v2/service_accounts/{service_account_id}/application_keys | Create an application key for this service account -*DatadogAPIClient::V2::ServiceAccountsAPI* | [**delete_service_account_application_key**](ServiceAccountsAPI.md#delete_service_account_application_key) | **DELETE** /api/v2/service_accounts/{service_account_id}/application_keys/{app_key_id} | Delete an application key for this service account -*DatadogAPIClient::V2::ServiceAccountsAPI* | [**get_service_account_application_key**](ServiceAccountsAPI.md#get_service_account_application_key) | **GET** /api/v2/service_accounts/{service_account_id}/application_keys/{app_key_id} | Get one application key for this service account -*DatadogAPIClient::V2::ServiceAccountsAPI* | [**list_service_account_application_keys**](ServiceAccountsAPI.md#list_service_account_application_keys) | **GET** /api/v2/service_accounts/{service_account_id}/application_keys | List application keys for this service account -*DatadogAPIClient::V2::ServiceAccountsAPI* | [**update_service_account_application_key**](ServiceAccountsAPI.md#update_service_account_application_key) | **PATCH** /api/v2/service_accounts/{service_account_id}/application_keys/{app_key_id} | Edit an application key for this service account -*DatadogAPIClient::V2::UsersAPI* | [**create_service_account**](UsersAPI.md#create_service_account) | **POST** /api/v2/service_accounts | Create a service account -*DatadogAPIClient::V2::UsersAPI* | [**create_user**](UsersAPI.md#create_user) | **POST** /api/v2/users | Create a user -*DatadogAPIClient::V2::UsersAPI* | [**disable_user**](UsersAPI.md#disable_user) | **DELETE** /api/v2/users/{user_id} | Disable a user -*DatadogAPIClient::V2::UsersAPI* | [**get_invitation**](UsersAPI.md#get_invitation) | **GET** /api/v2/user_invitations/{user_invitation_uuid} | Get a user invitation -*DatadogAPIClient::V2::UsersAPI* | [**get_user**](UsersAPI.md#get_user) | **GET** /api/v2/users/{user_id} | Get user details -*DatadogAPIClient::V2::UsersAPI* | [**list_user_organizations**](UsersAPI.md#list_user_organizations) | **GET** /api/v2/users/{user_id}/orgs | Get a user organization -*DatadogAPIClient::V2::UsersAPI* | [**list_user_permissions**](UsersAPI.md#list_user_permissions) | **GET** /api/v2/users/{user_id}/permissions | Get a user permissions -*DatadogAPIClient::V2::UsersAPI* | [**list_users**](UsersAPI.md#list_users) | **GET** /api/v2/users | List all users -*DatadogAPIClient::V2::UsersAPI* | [**send_invitations**](UsersAPI.md#send_invitations) | **POST** /api/v2/user_invitations | Send invitation emails -*DatadogAPIClient::V2::UsersAPI* | [**update_user**](UsersAPI.md#update_user) | **PATCH** /api/v2/users/{user_id} | Update a user - +| Class | Method | HTTP request | Description | +| --------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | -------------------------------------------------- | +| _DatadogAPIClient::V2::DashboardListsAPI_ | [**create_dashboard_list_items**](DashboardListsAPI.md#create_dashboard_list_items) | **POST** /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards | Add Items to a Dashboard List | +| _DatadogAPIClient::V2::DashboardListsAPI_ | [**delete_dashboard_list_items**](DashboardListsAPI.md#delete_dashboard_list_items) | **DELETE** /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards | Delete items from a dashboard list | +| _DatadogAPIClient::V2::DashboardListsAPI_ | [**get_dashboard_list_items**](DashboardListsAPI.md#get_dashboard_list_items) | **GET** /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards | Get items of a Dashboard List | +| _DatadogAPIClient::V2::DashboardListsAPI_ | [**update_dashboard_list_items**](DashboardListsAPI.md#update_dashboard_list_items) | **PUT** /api/v2/dashboard/lists/manual/{dashboard_list_id}/dashboards | Update items of a dashboard list | +| _DatadogAPIClient::V2::IncidentServicesAPI_ | [**create_incident_service**](IncidentServicesAPI.md#create_incident_service) | **POST** /api/v2/services | Create a new incident service | +| _DatadogAPIClient::V2::IncidentServicesAPI_ | [**delete_incident_service**](IncidentServicesAPI.md#delete_incident_service) | **DELETE** /api/v2/services/{service_id} | Delete an existing incident service | +| _DatadogAPIClient::V2::IncidentServicesAPI_ | [**get_incident_service**](IncidentServicesAPI.md#get_incident_service) | **GET** /api/v2/services/{service_id} | Get details of an incident service | +| _DatadogAPIClient::V2::IncidentServicesAPI_ | [**list_incident_services**](IncidentServicesAPI.md#list_incident_services) | **GET** /api/v2/services | Get a list of all incident services | +| _DatadogAPIClient::V2::IncidentServicesAPI_ | [**update_incident_service**](IncidentServicesAPI.md#update_incident_service) | **PATCH** /api/v2/services/{service_id} | Update an existing incident service | +| _DatadogAPIClient::V2::IncidentTeamsAPI_ | [**create_incident_team**](IncidentTeamsAPI.md#create_incident_team) | **POST** /api/v2/teams | Create a new incident team | +| _DatadogAPIClient::V2::IncidentTeamsAPI_ | [**delete_incident_team**](IncidentTeamsAPI.md#delete_incident_team) | **DELETE** /api/v2/teams/{team_id} | Delete an existing incident team | +| _DatadogAPIClient::V2::IncidentTeamsAPI_ | [**get_incident_team**](IncidentTeamsAPI.md#get_incident_team) | **GET** /api/v2/teams/{team_id} | Get details of an incident team | +| _DatadogAPIClient::V2::IncidentTeamsAPI_ | [**list_incident_teams**](IncidentTeamsAPI.md#list_incident_teams) | **GET** /api/v2/teams | Get a list of all incident teams | +| _DatadogAPIClient::V2::IncidentTeamsAPI_ | [**update_incident_team**](IncidentTeamsAPI.md#update_incident_team) | **PATCH** /api/v2/teams/{team_id} | Update an existing incident team | +| _DatadogAPIClient::V2::IncidentsAPI_ | [**create_incident**](IncidentsAPI.md#create_incident) | **POST** /api/v2/incidents | Create an incident | +| _DatadogAPIClient::V2::IncidentsAPI_ | [**delete_incident**](IncidentsAPI.md#delete_incident) | **DELETE** /api/v2/incidents/{incident_id} | Delete an existing incident | +| _DatadogAPIClient::V2::IncidentsAPI_ | [**get_incident**](IncidentsAPI.md#get_incident) | **GET** /api/v2/incidents/{incident_id} | Get the details of an incident | +| _DatadogAPIClient::V2::IncidentsAPI_ | [**list_incidents**](IncidentsAPI.md#list_incidents) | **GET** /api/v2/incidents | Get a list of incidents | +| _DatadogAPIClient::V2::IncidentsAPI_ | [**update_incident**](IncidentsAPI.md#update_incident) | **PATCH** /api/v2/incidents/{incident_id} | Update an existing incident | +| _DatadogAPIClient::V2::KeyManagementAPI_ | [**create_api_key**](KeyManagementAPI.md#create_api_key) | **POST** /api/v2/api_keys | Create an API key | +| _DatadogAPIClient::V2::KeyManagementAPI_ | [**create_current_user_application_key**](KeyManagementAPI.md#create_current_user_application_key) | **POST** /api/v2/current_user/application_keys | Create an application key for current user | +| _DatadogAPIClient::V2::KeyManagementAPI_ | [**delete_api_key**](KeyManagementAPI.md#delete_api_key) | **DELETE** /api/v2/api_keys/{api_key_id} | Delete an API key | +| _DatadogAPIClient::V2::KeyManagementAPI_ | [**delete_application_key**](KeyManagementAPI.md#delete_application_key) | **DELETE** /api/v2/application_keys/{app_key_id} | Delete an application key | +| _DatadogAPIClient::V2::KeyManagementAPI_ | [**delete_current_user_application_key**](KeyManagementAPI.md#delete_current_user_application_key) | **DELETE** /api/v2/current_user/application_keys/{app_key_id} | Delete an application key owned by current user | +| _DatadogAPIClient::V2::KeyManagementAPI_ | [**get_api_key**](KeyManagementAPI.md#get_api_key) | **GET** /api/v2/api_keys/{api_key_id} | Get API key | +| _DatadogAPIClient::V2::KeyManagementAPI_ | [**get_application_key**](KeyManagementAPI.md#get_application_key) | **GET** /api/v2/application_keys/{app_key_id} | Get an application key | +| _DatadogAPIClient::V2::KeyManagementAPI_ | [**get_current_user_application_key**](KeyManagementAPI.md#get_current_user_application_key) | **GET** /api/v2/current_user/application_keys/{app_key_id} | Get one application key owned by current user | +| _DatadogAPIClient::V2::KeyManagementAPI_ | [**list_api_keys**](KeyManagementAPI.md#list_api_keys) | **GET** /api/v2/api_keys | Get all API keys | +| _DatadogAPIClient::V2::KeyManagementAPI_ | [**list_application_keys**](KeyManagementAPI.md#list_application_keys) | **GET** /api/v2/application_keys | Get all application keys | +| _DatadogAPIClient::V2::KeyManagementAPI_ | [**list_current_user_application_keys**](KeyManagementAPI.md#list_current_user_application_keys) | **GET** /api/v2/current_user/application_keys | Get all application keys owned by current user | +| _DatadogAPIClient::V2::KeyManagementAPI_ | [**update_api_key**](KeyManagementAPI.md#update_api_key) | **PATCH** /api/v2/api_keys/{api_key_id} | Edit an API key | +| _DatadogAPIClient::V2::KeyManagementAPI_ | [**update_application_key**](KeyManagementAPI.md#update_application_key) | **PATCH** /api/v2/application_keys/{app_key_id} | Edit an application key | +| _DatadogAPIClient::V2::KeyManagementAPI_ | [**update_current_user_application_key**](KeyManagementAPI.md#update_current_user_application_key) | **PATCH** /api/v2/current_user/application_keys/{app_key_id} | Edit an application key owned by current user | +| _DatadogAPIClient::V2::LogsAPI_ | [**aggregate_logs**](LogsAPI.md#aggregate_logs) | **POST** /api/v2/logs/analytics/aggregate | Aggregate events | +| _DatadogAPIClient::V2::LogsAPI_ | [**list_logs**](LogsAPI.md#list_logs) | **POST** /api/v2/logs/events/search | Search logs | +| _DatadogAPIClient::V2::LogsAPI_ | [**list_logs_get**](LogsAPI.md#list_logs_get) | **GET** /api/v2/logs/events | Get a list of logs | +| _DatadogAPIClient::V2::LogsArchivesAPI_ | [**add_read_role_to_archive**](LogsArchivesAPI.md#add_read_role_to_archive) | **POST** /api/v2/logs/config/archives/{archive_id}/readers | Grant role to an archive | +| _DatadogAPIClient::V2::LogsArchivesAPI_ | [**create_logs_archive**](LogsArchivesAPI.md#create_logs_archive) | **POST** /api/v2/logs/config/archives | Create an archive | +| _DatadogAPIClient::V2::LogsArchivesAPI_ | [**delete_logs_archive**](LogsArchivesAPI.md#delete_logs_archive) | **DELETE** /api/v2/logs/config/archives/{archive_id} | Delete an archive | +| _DatadogAPIClient::V2::LogsArchivesAPI_ | [**get_logs_archive**](LogsArchivesAPI.md#get_logs_archive) | **GET** /api/v2/logs/config/archives/{archive_id} | Get an archive | +| _DatadogAPIClient::V2::LogsArchivesAPI_ | [**get_logs_archive_order**](LogsArchivesAPI.md#get_logs_archive_order) | **GET** /api/v2/logs/config/archive-order | Get archive order | +| _DatadogAPIClient::V2::LogsArchivesAPI_ | [**list_archive_read_roles**](LogsArchivesAPI.md#list_archive_read_roles) | **GET** /api/v2/logs/config/archives/{archive_id}/readers | List read roles for an archive | +| _DatadogAPIClient::V2::LogsArchivesAPI_ | [**list_logs_archives**](LogsArchivesAPI.md#list_logs_archives) | **GET** /api/v2/logs/config/archives | Get all archives | +| _DatadogAPIClient::V2::LogsArchivesAPI_ | [**remove_role_from_archive**](LogsArchivesAPI.md#remove_role_from_archive) | **DELETE** /api/v2/logs/config/archives/{archive_id}/readers | Revoke role from an archive | +| _DatadogAPIClient::V2::LogsArchivesAPI_ | [**update_logs_archive**](LogsArchivesAPI.md#update_logs_archive) | **PUT** /api/v2/logs/config/archives/{archive_id} | Update an archive | +| _DatadogAPIClient::V2::LogsArchivesAPI_ | [**update_logs_archive_order**](LogsArchivesAPI.md#update_logs_archive_order) | **PUT** /api/v2/logs/config/archive-order | Update archive order | +| _DatadogAPIClient::V2::LogsMetricsAPI_ | [**create_logs_metric**](LogsMetricsAPI.md#create_logs_metric) | **POST** /api/v2/logs/config/metrics | Create a log-based metric | +| _DatadogAPIClient::V2::LogsMetricsAPI_ | [**delete_logs_metric**](LogsMetricsAPI.md#delete_logs_metric) | **DELETE** /api/v2/logs/config/metrics/{metric_id} | Delete a log-based metric | +| _DatadogAPIClient::V2::LogsMetricsAPI_ | [**get_logs_metric**](LogsMetricsAPI.md#get_logs_metric) | **GET** /api/v2/logs/config/metrics/{metric_id} | Get a log-based metric | +| _DatadogAPIClient::V2::LogsMetricsAPI_ | [**list_logs_metrics**](LogsMetricsAPI.md#list_logs_metrics) | **GET** /api/v2/logs/config/metrics | Get all log-based metrics | +| _DatadogAPIClient::V2::LogsMetricsAPI_ | [**update_logs_metric**](LogsMetricsAPI.md#update_logs_metric) | **PATCH** /api/v2/logs/config/metrics/{metric_id} | Update a log-based metric | +| _DatadogAPIClient::V2::MetricsAPI_ | [**create_tag_configuration**](MetricsAPI.md#create_tag_configuration) | **POST** /api/v2/metrics/{metric_name}/tags | Create a tag configuration | +| _DatadogAPIClient::V2::MetricsAPI_ | [**delete_tag_configuration**](MetricsAPI.md#delete_tag_configuration) | **DELETE** /api/v2/metrics/{metric_name}/tags | Delete a tag configuration | +| _DatadogAPIClient::V2::MetricsAPI_ | [**list_tag_configuration_by_name**](MetricsAPI.md#list_tag_configuration_by_name) | **GET** /api/v2/metrics/{metric_name}/tags | List tag configuration by name | +| _DatadogAPIClient::V2::MetricsAPI_ | [**list_tag_configurations**](MetricsAPI.md#list_tag_configurations) | **GET** /api/v2/metrics | List tag configurations | +| _DatadogAPIClient::V2::MetricsAPI_ | [**list_tags_by_metric_name**](MetricsAPI.md#list_tags_by_metric_name) | **GET** /api/v2/metrics/{metric_name}/all-tags | List tags by metric name | +| _DatadogAPIClient::V2::MetricsAPI_ | [**list_volumes_by_metric_name**](MetricsAPI.md#list_volumes_by_metric_name) | **GET** /api/v2/metrics/{metric_name}/volumes | List distinct metric volumes by metric name | +| _DatadogAPIClient::V2::MetricsAPI_ | [**update_tag_configuration**](MetricsAPI.md#update_tag_configuration) | **PATCH** /api/v2/metrics/{metric_name}/tags | Update a tag configuration | +| _DatadogAPIClient::V2::ProcessesAPI_ | [**list_processes**](ProcessesAPI.md#list_processes) | **GET** /api/v2/processes | Get all processes | +| _DatadogAPIClient::V2::RolesAPI_ | [**add_permission_to_role**](RolesAPI.md#add_permission_to_role) | **POST** /api/v2/roles/{role_id}/permissions | Grant permission to a role | +| _DatadogAPIClient::V2::RolesAPI_ | [**add_user_to_role**](RolesAPI.md#add_user_to_role) | **POST** /api/v2/roles/{role_id}/users | Add a user to a role | +| _DatadogAPIClient::V2::RolesAPI_ | [**create_role**](RolesAPI.md#create_role) | **POST** /api/v2/roles | Create role | +| _DatadogAPIClient::V2::RolesAPI_ | [**delete_role**](RolesAPI.md#delete_role) | **DELETE** /api/v2/roles/{role_id} | Delete role | +| _DatadogAPIClient::V2::RolesAPI_ | [**get_role**](RolesAPI.md#get_role) | **GET** /api/v2/roles/{role_id} | Get a role | +| _DatadogAPIClient::V2::RolesAPI_ | [**list_permissions**](RolesAPI.md#list_permissions) | **GET** /api/v2/permissions | List permissions | +| _DatadogAPIClient::V2::RolesAPI_ | [**list_role_permissions**](RolesAPI.md#list_role_permissions) | **GET** /api/v2/roles/{role_id}/permissions | List permissions for a role | +| _DatadogAPIClient::V2::RolesAPI_ | [**list_role_users**](RolesAPI.md#list_role_users) | **GET** /api/v2/roles/{role_id}/users | Get all users of a role | +| _DatadogAPIClient::V2::RolesAPI_ | [**list_roles**](RolesAPI.md#list_roles) | **GET** /api/v2/roles | List roles | +| _DatadogAPIClient::V2::RolesAPI_ | [**remove_permission_from_role**](RolesAPI.md#remove_permission_from_role) | **DELETE** /api/v2/roles/{role_id}/permissions | Revoke permission | +| _DatadogAPIClient::V2::RolesAPI_ | [**remove_user_from_role**](RolesAPI.md#remove_user_from_role) | **DELETE** /api/v2/roles/{role_id}/users | Remove a user from a role | +| _DatadogAPIClient::V2::RolesAPI_ | [**update_role**](RolesAPI.md#update_role) | **PATCH** /api/v2/roles/{role_id} | Update a role | +| _DatadogAPIClient::V2::SecurityMonitoringAPI_ | [**create_security_filter**](SecurityMonitoringAPI.md#create_security_filter) | **POST** /api/v2/security_monitoring/configuration/security_filters | Create a security filter | +| _DatadogAPIClient::V2::SecurityMonitoringAPI_ | [**create_security_monitoring_rule**](SecurityMonitoringAPI.md#create_security_monitoring_rule) | **POST** /api/v2/security_monitoring/rules | Create a detection rule | +| _DatadogAPIClient::V2::SecurityMonitoringAPI_ | [**delete_security_filter**](SecurityMonitoringAPI.md#delete_security_filter) | **DELETE** /api/v2/security_monitoring/configuration/security_filters/{security_filter_id} | Delete a security filter | +| _DatadogAPIClient::V2::SecurityMonitoringAPI_ | [**delete_security_monitoring_rule**](SecurityMonitoringAPI.md#delete_security_monitoring_rule) | **DELETE** /api/v2/security_monitoring/rules/{rule_id} | Delete an existing rule | +| _DatadogAPIClient::V2::SecurityMonitoringAPI_ | [**get_security_filter**](SecurityMonitoringAPI.md#get_security_filter) | **GET** /api/v2/security_monitoring/configuration/security_filters/{security_filter_id} | Get a security filter | +| _DatadogAPIClient::V2::SecurityMonitoringAPI_ | [**get_security_monitoring_rule**](SecurityMonitoringAPI.md#get_security_monitoring_rule) | **GET** /api/v2/security_monitoring/rules/{rule_id} | Get a rule's details | +| _DatadogAPIClient::V2::SecurityMonitoringAPI_ | [**list_security_filters**](SecurityMonitoringAPI.md#list_security_filters) | **GET** /api/v2/security_monitoring/configuration/security_filters | Get all security filters | +| _DatadogAPIClient::V2::SecurityMonitoringAPI_ | [**list_security_monitoring_rules**](SecurityMonitoringAPI.md#list_security_monitoring_rules) | **GET** /api/v2/security_monitoring/rules | List rules | +| _DatadogAPIClient::V2::SecurityMonitoringAPI_ | [**list_security_monitoring_signals**](SecurityMonitoringAPI.md#list_security_monitoring_signals) | **GET** /api/v2/security_monitoring/signals | Get a quick list of security signals | +| _DatadogAPIClient::V2::SecurityMonitoringAPI_ | [**search_security_monitoring_signals**](SecurityMonitoringAPI.md#search_security_monitoring_signals) | **POST** /api/v2/security_monitoring/signals/search | Get a list of security signals | +| _DatadogAPIClient::V2::SecurityMonitoringAPI_ | [**update_security_filter**](SecurityMonitoringAPI.md#update_security_filter) | **PATCH** /api/v2/security_monitoring/configuration/security_filters/{security_filter_id} | Update a security filter | +| _DatadogAPIClient::V2::SecurityMonitoringAPI_ | [**update_security_monitoring_rule**](SecurityMonitoringAPI.md#update_security_monitoring_rule) | **PUT** /api/v2/security_monitoring/rules/{rule_id} | Update an existing rule | +| _DatadogAPIClient::V2::ServiceAccountsAPI_ | [**create_service_account_application_key**](ServiceAccountsAPI.md#create_service_account_application_key) | **POST** /api/v2/service_accounts/{service_account_id}/application_keys | Create an application key for this service account | +| _DatadogAPIClient::V2::ServiceAccountsAPI_ | [**delete_service_account_application_key**](ServiceAccountsAPI.md#delete_service_account_application_key) | **DELETE** /api/v2/service_accounts/{service_account_id}/application_keys/{app_key_id} | Delete an application key for this service account | +| _DatadogAPIClient::V2::ServiceAccountsAPI_ | [**get_service_account_application_key**](ServiceAccountsAPI.md#get_service_account_application_key) | **GET** /api/v2/service_accounts/{service_account_id}/application_keys/{app_key_id} | Get one application key for this service account | +| _DatadogAPIClient::V2::ServiceAccountsAPI_ | [**list_service_account_application_keys**](ServiceAccountsAPI.md#list_service_account_application_keys) | **GET** /api/v2/service_accounts/{service_account_id}/application_keys | List application keys for this service account | +| _DatadogAPIClient::V2::ServiceAccountsAPI_ | [**update_service_account_application_key**](ServiceAccountsAPI.md#update_service_account_application_key) | **PATCH** /api/v2/service_accounts/{service_account_id}/application_keys/{app_key_id} | Edit an application key for this service account | +| _DatadogAPIClient::V2::UsersAPI_ | [**create_service_account**](UsersAPI.md#create_service_account) | **POST** /api/v2/service_accounts | Create a service account | +| _DatadogAPIClient::V2::UsersAPI_ | [**create_user**](UsersAPI.md#create_user) | **POST** /api/v2/users | Create a user | +| _DatadogAPIClient::V2::UsersAPI_ | [**disable_user**](UsersAPI.md#disable_user) | **DELETE** /api/v2/users/{user_id} | Disable a user | +| _DatadogAPIClient::V2::UsersAPI_ | [**get_invitation**](UsersAPI.md#get_invitation) | **GET** /api/v2/user_invitations/{user_invitation_uuid} | Get a user invitation | +| _DatadogAPIClient::V2::UsersAPI_ | [**get_user**](UsersAPI.md#get_user) | **GET** /api/v2/users/{user_id} | Get user details | +| _DatadogAPIClient::V2::UsersAPI_ | [**list_user_organizations**](UsersAPI.md#list_user_organizations) | **GET** /api/v2/users/{user_id}/orgs | Get a user organization | +| _DatadogAPIClient::V2::UsersAPI_ | [**list_user_permissions**](UsersAPI.md#list_user_permissions) | **GET** /api/v2/users/{user_id}/permissions | Get a user permissions | +| _DatadogAPIClient::V2::UsersAPI_ | [**list_users**](UsersAPI.md#list_users) | **GET** /api/v2/users | List all users | +| _DatadogAPIClient::V2::UsersAPI_ | [**send_invitations**](UsersAPI.md#send_invitations) | **POST** /api/v2/user_invitations | Send invitation emails | +| _DatadogAPIClient::V2::UsersAPI_ | [**update_user**](UsersAPI.md#update_user) | **PATCH** /api/v2/users/{user_id} | Update a user | ## Documentation for Models - - [DatadogAPIClient::V2::APIErrorResponse](APIErrorResponse.md) - - [DatadogAPIClient::V2::APIKeyCreateAttributes](APIKeyCreateAttributes.md) - - [DatadogAPIClient::V2::APIKeyCreateData](APIKeyCreateData.md) - - [DatadogAPIClient::V2::APIKeyCreateRequest](APIKeyCreateRequest.md) - - [DatadogAPIClient::V2::APIKeyRelationships](APIKeyRelationships.md) - - [DatadogAPIClient::V2::APIKeyResponse](APIKeyResponse.md) - - [DatadogAPIClient::V2::APIKeyResponseIncludedItem](APIKeyResponseIncludedItem.md) - - [DatadogAPIClient::V2::APIKeyUpdateAttributes](APIKeyUpdateAttributes.md) - - [DatadogAPIClient::V2::APIKeyUpdateData](APIKeyUpdateData.md) - - [DatadogAPIClient::V2::APIKeyUpdateRequest](APIKeyUpdateRequest.md) - - [DatadogAPIClient::V2::APIKeysResponse](APIKeysResponse.md) - - [DatadogAPIClient::V2::APIKeysSort](APIKeysSort.md) - - [DatadogAPIClient::V2::APIKeysType](APIKeysType.md) - - [DatadogAPIClient::V2::ApplicationKeyCreateAttributes](ApplicationKeyCreateAttributes.md) - - [DatadogAPIClient::V2::ApplicationKeyCreateData](ApplicationKeyCreateData.md) - - [DatadogAPIClient::V2::ApplicationKeyCreateRequest](ApplicationKeyCreateRequest.md) - - [DatadogAPIClient::V2::ApplicationKeyRelationships](ApplicationKeyRelationships.md) - - [DatadogAPIClient::V2::ApplicationKeyResponse](ApplicationKeyResponse.md) - - [DatadogAPIClient::V2::ApplicationKeyResponseIncludedItem](ApplicationKeyResponseIncludedItem.md) - - [DatadogAPIClient::V2::ApplicationKeyUpdateAttributes](ApplicationKeyUpdateAttributes.md) - - [DatadogAPIClient::V2::ApplicationKeyUpdateData](ApplicationKeyUpdateData.md) - - [DatadogAPIClient::V2::ApplicationKeyUpdateRequest](ApplicationKeyUpdateRequest.md) - - [DatadogAPIClient::V2::ApplicationKeysSort](ApplicationKeysSort.md) - - [DatadogAPIClient::V2::ApplicationKeysType](ApplicationKeysType.md) - - [DatadogAPIClient::V2::Creator](Creator.md) - - [DatadogAPIClient::V2::DashboardListAddItemsRequest](DashboardListAddItemsRequest.md) - - [DatadogAPIClient::V2::DashboardListAddItemsResponse](DashboardListAddItemsResponse.md) - - [DatadogAPIClient::V2::DashboardListDeleteItemsRequest](DashboardListDeleteItemsRequest.md) - - [DatadogAPIClient::V2::DashboardListDeleteItemsResponse](DashboardListDeleteItemsResponse.md) - - [DatadogAPIClient::V2::DashboardListItem](DashboardListItem.md) - - [DatadogAPIClient::V2::DashboardListItemRequest](DashboardListItemRequest.md) - - [DatadogAPIClient::V2::DashboardListItemResponse](DashboardListItemResponse.md) - - [DatadogAPIClient::V2::DashboardListItems](DashboardListItems.md) - - [DatadogAPIClient::V2::DashboardListUpdateItemsRequest](DashboardListUpdateItemsRequest.md) - - [DatadogAPIClient::V2::DashboardListUpdateItemsResponse](DashboardListUpdateItemsResponse.md) - - [DatadogAPIClient::V2::DashboardType](DashboardType.md) - - [DatadogAPIClient::V2::FullAPIKey](FullAPIKey.md) - - [DatadogAPIClient::V2::FullAPIKeyAttributes](FullAPIKeyAttributes.md) - - [DatadogAPIClient::V2::FullApplicationKey](FullApplicationKey.md) - - [DatadogAPIClient::V2::FullApplicationKeyAttributes](FullApplicationKeyAttributes.md) - - [DatadogAPIClient::V2::IncidentCreateAttributes](IncidentCreateAttributes.md) - - [DatadogAPIClient::V2::IncidentCreateData](IncidentCreateData.md) - - [DatadogAPIClient::V2::IncidentCreateRelationships](IncidentCreateRelationships.md) - - [DatadogAPIClient::V2::IncidentCreateRequest](IncidentCreateRequest.md) - - [DatadogAPIClient::V2::IncidentFieldAttributes](IncidentFieldAttributes.md) - - [DatadogAPIClient::V2::IncidentFieldAttributesMultipleValue](IncidentFieldAttributesMultipleValue.md) - - [DatadogAPIClient::V2::IncidentFieldAttributesSingleValue](IncidentFieldAttributesSingleValue.md) - - [DatadogAPIClient::V2::IncidentFieldAttributesSingleValueType](IncidentFieldAttributesSingleValueType.md) - - [DatadogAPIClient::V2::IncidentFieldAttributesValueType](IncidentFieldAttributesValueType.md) - - [DatadogAPIClient::V2::IncidentIntegrationMetadataType](IncidentIntegrationMetadataType.md) - - [DatadogAPIClient::V2::IncidentNotificationHandle](IncidentNotificationHandle.md) - - [DatadogAPIClient::V2::IncidentPostmortemType](IncidentPostmortemType.md) - - [DatadogAPIClient::V2::IncidentRelatedObject](IncidentRelatedObject.md) - - [DatadogAPIClient::V2::IncidentResponse](IncidentResponse.md) - - [DatadogAPIClient::V2::IncidentResponseAttributes](IncidentResponseAttributes.md) - - [DatadogAPIClient::V2::IncidentResponseData](IncidentResponseData.md) - - [DatadogAPIClient::V2::IncidentResponseIncludedItem](IncidentResponseIncludedItem.md) - - [DatadogAPIClient::V2::IncidentResponseRelationships](IncidentResponseRelationships.md) - - [DatadogAPIClient::V2::IncidentServiceCreateAttributes](IncidentServiceCreateAttributes.md) - - [DatadogAPIClient::V2::IncidentServiceCreateData](IncidentServiceCreateData.md) - - [DatadogAPIClient::V2::IncidentServiceCreateRequest](IncidentServiceCreateRequest.md) - - [DatadogAPIClient::V2::IncidentServiceIncludedItems](IncidentServiceIncludedItems.md) - - [DatadogAPIClient::V2::IncidentServiceRelationships](IncidentServiceRelationships.md) - - [DatadogAPIClient::V2::IncidentServiceResponse](IncidentServiceResponse.md) - - [DatadogAPIClient::V2::IncidentServiceResponseAttributes](IncidentServiceResponseAttributes.md) - - [DatadogAPIClient::V2::IncidentServiceResponseData](IncidentServiceResponseData.md) - - [DatadogAPIClient::V2::IncidentServiceType](IncidentServiceType.md) - - [DatadogAPIClient::V2::IncidentServiceUpdateAttributes](IncidentServiceUpdateAttributes.md) - - [DatadogAPIClient::V2::IncidentServiceUpdateData](IncidentServiceUpdateData.md) - - [DatadogAPIClient::V2::IncidentServiceUpdateRequest](IncidentServiceUpdateRequest.md) - - [DatadogAPIClient::V2::IncidentServicesResponse](IncidentServicesResponse.md) - - [DatadogAPIClient::V2::IncidentServicesResponseMeta](IncidentServicesResponseMeta.md) - - [DatadogAPIClient::V2::IncidentServicesResponseMetaPagination](IncidentServicesResponseMetaPagination.md) - - [DatadogAPIClient::V2::IncidentTeamCreateAttributes](IncidentTeamCreateAttributes.md) - - [DatadogAPIClient::V2::IncidentTeamCreateData](IncidentTeamCreateData.md) - - [DatadogAPIClient::V2::IncidentTeamCreateRequest](IncidentTeamCreateRequest.md) - - [DatadogAPIClient::V2::IncidentTeamIncludedItems](IncidentTeamIncludedItems.md) - - [DatadogAPIClient::V2::IncidentTeamRelationships](IncidentTeamRelationships.md) - - [DatadogAPIClient::V2::IncidentTeamResponse](IncidentTeamResponse.md) - - [DatadogAPIClient::V2::IncidentTeamResponseAttributes](IncidentTeamResponseAttributes.md) - - [DatadogAPIClient::V2::IncidentTeamResponseData](IncidentTeamResponseData.md) - - [DatadogAPIClient::V2::IncidentTeamType](IncidentTeamType.md) - - [DatadogAPIClient::V2::IncidentTeamUpdateAttributes](IncidentTeamUpdateAttributes.md) - - [DatadogAPIClient::V2::IncidentTeamUpdateData](IncidentTeamUpdateData.md) - - [DatadogAPIClient::V2::IncidentTeamUpdateRequest](IncidentTeamUpdateRequest.md) - - [DatadogAPIClient::V2::IncidentTeamsResponse](IncidentTeamsResponse.md) - - [DatadogAPIClient::V2::IncidentTimelineCellCreateAttributes](IncidentTimelineCellCreateAttributes.md) - - [DatadogAPIClient::V2::IncidentTimelineCellMarkdownContentType](IncidentTimelineCellMarkdownContentType.md) - - [DatadogAPIClient::V2::IncidentTimelineCellMarkdownCreateAttributes](IncidentTimelineCellMarkdownCreateAttributes.md) - - [DatadogAPIClient::V2::IncidentTimelineCellMarkdownCreateAttributesContent](IncidentTimelineCellMarkdownCreateAttributesContent.md) - - [DatadogAPIClient::V2::IncidentType](IncidentType.md) - - [DatadogAPIClient::V2::IncidentUpdateAttributes](IncidentUpdateAttributes.md) - - [DatadogAPIClient::V2::IncidentUpdateData](IncidentUpdateData.md) - - [DatadogAPIClient::V2::IncidentUpdateRelationships](IncidentUpdateRelationships.md) - - [DatadogAPIClient::V2::IncidentUpdateRequest](IncidentUpdateRequest.md) - - [DatadogAPIClient::V2::IncidentsResponse](IncidentsResponse.md) - - [DatadogAPIClient::V2::ListApplicationKeysResponse](ListApplicationKeysResponse.md) - - [DatadogAPIClient::V2::Log](Log.md) - - [DatadogAPIClient::V2::LogAttributes](LogAttributes.md) - - [DatadogAPIClient::V2::LogType](LogType.md) - - [DatadogAPIClient::V2::LogsAggregateBucket](LogsAggregateBucket.md) - - [DatadogAPIClient::V2::LogsAggregateBucketValue](LogsAggregateBucketValue.md) - - [DatadogAPIClient::V2::LogsAggregateBucketValueTimeseriesPoint](LogsAggregateBucketValueTimeseriesPoint.md) - - [DatadogAPIClient::V2::LogsAggregateRequest](LogsAggregateRequest.md) - - [DatadogAPIClient::V2::LogsAggregateRequestPage](LogsAggregateRequestPage.md) - - [DatadogAPIClient::V2::LogsAggregateResponse](LogsAggregateResponse.md) - - [DatadogAPIClient::V2::LogsAggregateResponseData](LogsAggregateResponseData.md) - - [DatadogAPIClient::V2::LogsAggregateResponseStatus](LogsAggregateResponseStatus.md) - - [DatadogAPIClient::V2::LogsAggregateSort](LogsAggregateSort.md) - - [DatadogAPIClient::V2::LogsAggregateSortType](LogsAggregateSortType.md) - - [DatadogAPIClient::V2::LogsAggregationFunction](LogsAggregationFunction.md) - - [DatadogAPIClient::V2::LogsArchive](LogsArchive.md) - - [DatadogAPIClient::V2::LogsArchiveAttributes](LogsArchiveAttributes.md) - - [DatadogAPIClient::V2::LogsArchiveCreateRequest](LogsArchiveCreateRequest.md) - - [DatadogAPIClient::V2::LogsArchiveCreateRequestAttributes](LogsArchiveCreateRequestAttributes.md) - - [DatadogAPIClient::V2::LogsArchiveCreateRequestDefinition](LogsArchiveCreateRequestDefinition.md) - - [DatadogAPIClient::V2::LogsArchiveCreateRequestDestination](LogsArchiveCreateRequestDestination.md) - - [DatadogAPIClient::V2::LogsArchiveDefinition](LogsArchiveDefinition.md) - - [DatadogAPIClient::V2::LogsArchiveDestination](LogsArchiveDestination.md) - - [DatadogAPIClient::V2::LogsArchiveDestinationAzure](LogsArchiveDestinationAzure.md) - - [DatadogAPIClient::V2::LogsArchiveDestinationAzureType](LogsArchiveDestinationAzureType.md) - - [DatadogAPIClient::V2::LogsArchiveDestinationGCS](LogsArchiveDestinationGCS.md) - - [DatadogAPIClient::V2::LogsArchiveDestinationGCSType](LogsArchiveDestinationGCSType.md) - - [DatadogAPIClient::V2::LogsArchiveDestinationS3](LogsArchiveDestinationS3.md) - - [DatadogAPIClient::V2::LogsArchiveDestinationS3Type](LogsArchiveDestinationS3Type.md) - - [DatadogAPIClient::V2::LogsArchiveIntegrationAzure](LogsArchiveIntegrationAzure.md) - - [DatadogAPIClient::V2::LogsArchiveIntegrationGCS](LogsArchiveIntegrationGCS.md) - - [DatadogAPIClient::V2::LogsArchiveIntegrationS3](LogsArchiveIntegrationS3.md) - - [DatadogAPIClient::V2::LogsArchiveOrder](LogsArchiveOrder.md) - - [DatadogAPIClient::V2::LogsArchiveOrderAttributes](LogsArchiveOrderAttributes.md) - - [DatadogAPIClient::V2::LogsArchiveOrderDefinition](LogsArchiveOrderDefinition.md) - - [DatadogAPIClient::V2::LogsArchiveOrderDefinitionType](LogsArchiveOrderDefinitionType.md) - - [DatadogAPIClient::V2::LogsArchiveState](LogsArchiveState.md) - - [DatadogAPIClient::V2::LogsArchives](LogsArchives.md) - - [DatadogAPIClient::V2::LogsCompute](LogsCompute.md) - - [DatadogAPIClient::V2::LogsComputeType](LogsComputeType.md) - - [DatadogAPIClient::V2::LogsGroupBy](LogsGroupBy.md) - - [DatadogAPIClient::V2::LogsGroupByHistogram](LogsGroupByHistogram.md) - - [DatadogAPIClient::V2::LogsGroupByMissing](LogsGroupByMissing.md) - - [DatadogAPIClient::V2::LogsGroupByTotal](LogsGroupByTotal.md) - - [DatadogAPIClient::V2::LogsListRequest](LogsListRequest.md) - - [DatadogAPIClient::V2::LogsListRequestPage](LogsListRequestPage.md) - - [DatadogAPIClient::V2::LogsListResponse](LogsListResponse.md) - - [DatadogAPIClient::V2::LogsListResponseLinks](LogsListResponseLinks.md) - - [DatadogAPIClient::V2::LogsMetricCompute](LogsMetricCompute.md) - - [DatadogAPIClient::V2::LogsMetricComputeAggregationType](LogsMetricComputeAggregationType.md) - - [DatadogAPIClient::V2::LogsMetricCreateAttributes](LogsMetricCreateAttributes.md) - - [DatadogAPIClient::V2::LogsMetricCreateData](LogsMetricCreateData.md) - - [DatadogAPIClient::V2::LogsMetricCreateRequest](LogsMetricCreateRequest.md) - - [DatadogAPIClient::V2::LogsMetricFilter](LogsMetricFilter.md) - - [DatadogAPIClient::V2::LogsMetricGroupBy](LogsMetricGroupBy.md) - - [DatadogAPIClient::V2::LogsMetricResponse](LogsMetricResponse.md) - - [DatadogAPIClient::V2::LogsMetricResponseAttributes](LogsMetricResponseAttributes.md) - - [DatadogAPIClient::V2::LogsMetricResponseCompute](LogsMetricResponseCompute.md) - - [DatadogAPIClient::V2::LogsMetricResponseComputeAggregationType](LogsMetricResponseComputeAggregationType.md) - - [DatadogAPIClient::V2::LogsMetricResponseData](LogsMetricResponseData.md) - - [DatadogAPIClient::V2::LogsMetricResponseFilter](LogsMetricResponseFilter.md) - - [DatadogAPIClient::V2::LogsMetricResponseGroupBy](LogsMetricResponseGroupBy.md) - - [DatadogAPIClient::V2::LogsMetricType](LogsMetricType.md) - - [DatadogAPIClient::V2::LogsMetricUpdateAttributes](LogsMetricUpdateAttributes.md) - - [DatadogAPIClient::V2::LogsMetricUpdateData](LogsMetricUpdateData.md) - - [DatadogAPIClient::V2::LogsMetricUpdateRequest](LogsMetricUpdateRequest.md) - - [DatadogAPIClient::V2::LogsMetricsResponse](LogsMetricsResponse.md) - - [DatadogAPIClient::V2::LogsQueryFilter](LogsQueryFilter.md) - - [DatadogAPIClient::V2::LogsQueryOptions](LogsQueryOptions.md) - - [DatadogAPIClient::V2::LogsResponseMetadata](LogsResponseMetadata.md) - - [DatadogAPIClient::V2::LogsResponseMetadataPage](LogsResponseMetadataPage.md) - - [DatadogAPIClient::V2::LogsSort](LogsSort.md) - - [DatadogAPIClient::V2::LogsSortOrder](LogsSortOrder.md) - - [DatadogAPIClient::V2::LogsWarning](LogsWarning.md) - - [DatadogAPIClient::V2::Metric](Metric.md) - - [DatadogAPIClient::V2::MetricAllTags](MetricAllTags.md) - - [DatadogAPIClient::V2::MetricAllTagsAttributes](MetricAllTagsAttributes.md) - - [DatadogAPIClient::V2::MetricAllTagsResponse](MetricAllTagsResponse.md) - - [DatadogAPIClient::V2::MetricCustomAggregation](MetricCustomAggregation.md) - - [DatadogAPIClient::V2::MetricCustomSpaceAggregation](MetricCustomSpaceAggregation.md) - - [DatadogAPIClient::V2::MetricCustomTimeAggregation](MetricCustomTimeAggregation.md) - - [DatadogAPIClient::V2::MetricDistinctVolume](MetricDistinctVolume.md) - - [DatadogAPIClient::V2::MetricDistinctVolumeAttributes](MetricDistinctVolumeAttributes.md) - - [DatadogAPIClient::V2::MetricDistinctVolumeType](MetricDistinctVolumeType.md) - - [DatadogAPIClient::V2::MetricIngestedIndexedVolume](MetricIngestedIndexedVolume.md) - - [DatadogAPIClient::V2::MetricIngestedIndexedVolumeAttributes](MetricIngestedIndexedVolumeAttributes.md) - - [DatadogAPIClient::V2::MetricIngestedIndexedVolumeType](MetricIngestedIndexedVolumeType.md) - - [DatadogAPIClient::V2::MetricTagConfiguration](MetricTagConfiguration.md) - - [DatadogAPIClient::V2::MetricTagConfigurationAttributes](MetricTagConfigurationAttributes.md) - - [DatadogAPIClient::V2::MetricTagConfigurationCreateAttributes](MetricTagConfigurationCreateAttributes.md) - - [DatadogAPIClient::V2::MetricTagConfigurationCreateData](MetricTagConfigurationCreateData.md) - - [DatadogAPIClient::V2::MetricTagConfigurationCreateRequest](MetricTagConfigurationCreateRequest.md) - - [DatadogAPIClient::V2::MetricTagConfigurationMetricTypes](MetricTagConfigurationMetricTypes.md) - - [DatadogAPIClient::V2::MetricTagConfigurationResponse](MetricTagConfigurationResponse.md) - - [DatadogAPIClient::V2::MetricTagConfigurationType](MetricTagConfigurationType.md) - - [DatadogAPIClient::V2::MetricTagConfigurationUpdateAttributes](MetricTagConfigurationUpdateAttributes.md) - - [DatadogAPIClient::V2::MetricTagConfigurationUpdateData](MetricTagConfigurationUpdateData.md) - - [DatadogAPIClient::V2::MetricTagConfigurationUpdateRequest](MetricTagConfigurationUpdateRequest.md) - - [DatadogAPIClient::V2::MetricType](MetricType.md) - - [DatadogAPIClient::V2::MetricVolumes](MetricVolumes.md) - - [DatadogAPIClient::V2::MetricVolumesResponse](MetricVolumesResponse.md) - - [DatadogAPIClient::V2::MetricsAndMetricTagConfigurations](MetricsAndMetricTagConfigurations.md) - - [DatadogAPIClient::V2::MetricsAndMetricTagConfigurationsResponse](MetricsAndMetricTagConfigurationsResponse.md) - - [DatadogAPIClient::V2::Organization](Organization.md) - - [DatadogAPIClient::V2::OrganizationAttributes](OrganizationAttributes.md) - - [DatadogAPIClient::V2::OrganizationsType](OrganizationsType.md) - - [DatadogAPIClient::V2::Pagination](Pagination.md) - - [DatadogAPIClient::V2::PartialAPIKey](PartialAPIKey.md) - - [DatadogAPIClient::V2::PartialAPIKeyAttributes](PartialAPIKeyAttributes.md) - - [DatadogAPIClient::V2::PartialApplicationKey](PartialApplicationKey.md) - - [DatadogAPIClient::V2::PartialApplicationKeyAttributes](PartialApplicationKeyAttributes.md) - - [DatadogAPIClient::V2::PartialApplicationKeyResponse](PartialApplicationKeyResponse.md) - - [DatadogAPIClient::V2::Permission](Permission.md) - - [DatadogAPIClient::V2::PermissionAttributes](PermissionAttributes.md) - - [DatadogAPIClient::V2::PermissionsResponse](PermissionsResponse.md) - - [DatadogAPIClient::V2::PermissionsType](PermissionsType.md) - - [DatadogAPIClient::V2::ProcessSummariesMeta](ProcessSummariesMeta.md) - - [DatadogAPIClient::V2::ProcessSummariesMetaPage](ProcessSummariesMetaPage.md) - - [DatadogAPIClient::V2::ProcessSummariesResponse](ProcessSummariesResponse.md) - - [DatadogAPIClient::V2::ProcessSummary](ProcessSummary.md) - - [DatadogAPIClient::V2::ProcessSummaryAttributes](ProcessSummaryAttributes.md) - - [DatadogAPIClient::V2::ProcessSummaryType](ProcessSummaryType.md) - - [DatadogAPIClient::V2::QuerySortOrder](QuerySortOrder.md) - - [DatadogAPIClient::V2::RelationshipToIncidentIntegrationMetadataData](RelationshipToIncidentIntegrationMetadataData.md) - - [DatadogAPIClient::V2::RelationshipToIncidentIntegrationMetadatas](RelationshipToIncidentIntegrationMetadatas.md) - - [DatadogAPIClient::V2::RelationshipToIncidentPostmortem](RelationshipToIncidentPostmortem.md) - - [DatadogAPIClient::V2::RelationshipToIncidentPostmortemData](RelationshipToIncidentPostmortemData.md) - - [DatadogAPIClient::V2::RelationshipToOrganization](RelationshipToOrganization.md) - - [DatadogAPIClient::V2::RelationshipToOrganizationData](RelationshipToOrganizationData.md) - - [DatadogAPIClient::V2::RelationshipToOrganizations](RelationshipToOrganizations.md) - - [DatadogAPIClient::V2::RelationshipToPermission](RelationshipToPermission.md) - - [DatadogAPIClient::V2::RelationshipToPermissionData](RelationshipToPermissionData.md) - - [DatadogAPIClient::V2::RelationshipToPermissions](RelationshipToPermissions.md) - - [DatadogAPIClient::V2::RelationshipToRole](RelationshipToRole.md) - - [DatadogAPIClient::V2::RelationshipToRoleData](RelationshipToRoleData.md) - - [DatadogAPIClient::V2::RelationshipToRoles](RelationshipToRoles.md) - - [DatadogAPIClient::V2::RelationshipToUser](RelationshipToUser.md) - - [DatadogAPIClient::V2::RelationshipToUserData](RelationshipToUserData.md) - - [DatadogAPIClient::V2::RelationshipToUsers](RelationshipToUsers.md) - - [DatadogAPIClient::V2::ResponseMetaAttributes](ResponseMetaAttributes.md) - - [DatadogAPIClient::V2::Role](Role.md) - - [DatadogAPIClient::V2::RoleAttributes](RoleAttributes.md) - - [DatadogAPIClient::V2::RoleCreateAttributes](RoleCreateAttributes.md) - - [DatadogAPIClient::V2::RoleCreateData](RoleCreateData.md) - - [DatadogAPIClient::V2::RoleCreateRequest](RoleCreateRequest.md) - - [DatadogAPIClient::V2::RoleCreateResponse](RoleCreateResponse.md) - - [DatadogAPIClient::V2::RoleCreateResponseData](RoleCreateResponseData.md) - - [DatadogAPIClient::V2::RoleRelationships](RoleRelationships.md) - - [DatadogAPIClient::V2::RoleResponse](RoleResponse.md) - - [DatadogAPIClient::V2::RoleResponseRelationships](RoleResponseRelationships.md) - - [DatadogAPIClient::V2::RoleUpdateAttributes](RoleUpdateAttributes.md) - - [DatadogAPIClient::V2::RoleUpdateData](RoleUpdateData.md) - - [DatadogAPIClient::V2::RoleUpdateRequest](RoleUpdateRequest.md) - - [DatadogAPIClient::V2::RoleUpdateResponse](RoleUpdateResponse.md) - - [DatadogAPIClient::V2::RoleUpdateResponseData](RoleUpdateResponseData.md) - - [DatadogAPIClient::V2::RolesResponse](RolesResponse.md) - - [DatadogAPIClient::V2::RolesSort](RolesSort.md) - - [DatadogAPIClient::V2::RolesType](RolesType.md) - - [DatadogAPIClient::V2::SecurityFilter](SecurityFilter.md) - - [DatadogAPIClient::V2::SecurityFilterAttributes](SecurityFilterAttributes.md) - - [DatadogAPIClient::V2::SecurityFilterCreateAttributes](SecurityFilterCreateAttributes.md) - - [DatadogAPIClient::V2::SecurityFilterCreateData](SecurityFilterCreateData.md) - - [DatadogAPIClient::V2::SecurityFilterCreateRequest](SecurityFilterCreateRequest.md) - - [DatadogAPIClient::V2::SecurityFilterExclusionFilter](SecurityFilterExclusionFilter.md) - - [DatadogAPIClient::V2::SecurityFilterExclusionFilterResponse](SecurityFilterExclusionFilterResponse.md) - - [DatadogAPIClient::V2::SecurityFilterFilteredDataType](SecurityFilterFilteredDataType.md) - - [DatadogAPIClient::V2::SecurityFilterMeta](SecurityFilterMeta.md) - - [DatadogAPIClient::V2::SecurityFilterResponse](SecurityFilterResponse.md) - - [DatadogAPIClient::V2::SecurityFilterType](SecurityFilterType.md) - - [DatadogAPIClient::V2::SecurityFilterUpdateAttributes](SecurityFilterUpdateAttributes.md) - - [DatadogAPIClient::V2::SecurityFilterUpdateData](SecurityFilterUpdateData.md) - - [DatadogAPIClient::V2::SecurityFilterUpdateRequest](SecurityFilterUpdateRequest.md) - - [DatadogAPIClient::V2::SecurityFiltersResponse](SecurityFiltersResponse.md) - - [DatadogAPIClient::V2::SecurityMonitoringFilter](SecurityMonitoringFilter.md) - - [DatadogAPIClient::V2::SecurityMonitoringFilterAction](SecurityMonitoringFilterAction.md) - - [DatadogAPIClient::V2::SecurityMonitoringListRulesResponse](SecurityMonitoringListRulesResponse.md) - - [DatadogAPIClient::V2::SecurityMonitoringRuleCase](SecurityMonitoringRuleCase.md) - - [DatadogAPIClient::V2::SecurityMonitoringRuleCaseCreate](SecurityMonitoringRuleCaseCreate.md) - - [DatadogAPIClient::V2::SecurityMonitoringRuleCreatePayload](SecurityMonitoringRuleCreatePayload.md) - - [DatadogAPIClient::V2::SecurityMonitoringRuleDetectionMethod](SecurityMonitoringRuleDetectionMethod.md) - - [DatadogAPIClient::V2::SecurityMonitoringRuleEvaluationWindow](SecurityMonitoringRuleEvaluationWindow.md) - - [DatadogAPIClient::V2::SecurityMonitoringRuleKeepAlive](SecurityMonitoringRuleKeepAlive.md) - - [DatadogAPIClient::V2::SecurityMonitoringRuleMaxSignalDuration](SecurityMonitoringRuleMaxSignalDuration.md) - - [DatadogAPIClient::V2::SecurityMonitoringRuleNewValueOptions](SecurityMonitoringRuleNewValueOptions.md) - - [DatadogAPIClient::V2::SecurityMonitoringRuleNewValueOptionsForgetAfter](SecurityMonitoringRuleNewValueOptionsForgetAfter.md) - - [DatadogAPIClient::V2::SecurityMonitoringRuleNewValueOptionsLearningDuration](SecurityMonitoringRuleNewValueOptionsLearningDuration.md) - - [DatadogAPIClient::V2::SecurityMonitoringRuleOptions](SecurityMonitoringRuleOptions.md) - - [DatadogAPIClient::V2::SecurityMonitoringRuleQuery](SecurityMonitoringRuleQuery.md) - - [DatadogAPIClient::V2::SecurityMonitoringRuleQueryAggregation](SecurityMonitoringRuleQueryAggregation.md) - - [DatadogAPIClient::V2::SecurityMonitoringRuleQueryCreate](SecurityMonitoringRuleQueryCreate.md) - - [DatadogAPIClient::V2::SecurityMonitoringRuleResponse](SecurityMonitoringRuleResponse.md) - - [DatadogAPIClient::V2::SecurityMonitoringRuleSeverity](SecurityMonitoringRuleSeverity.md) - - [DatadogAPIClient::V2::SecurityMonitoringRuleTypeCreate](SecurityMonitoringRuleTypeCreate.md) - - [DatadogAPIClient::V2::SecurityMonitoringRuleTypeRead](SecurityMonitoringRuleTypeRead.md) - - [DatadogAPIClient::V2::SecurityMonitoringRuleUpdatePayload](SecurityMonitoringRuleUpdatePayload.md) - - [DatadogAPIClient::V2::SecurityMonitoringRuntimeAgentRule](SecurityMonitoringRuntimeAgentRule.md) - - [DatadogAPIClient::V2::SecurityMonitoringSignal](SecurityMonitoringSignal.md) - - [DatadogAPIClient::V2::SecurityMonitoringSignalAttributes](SecurityMonitoringSignalAttributes.md) - - [DatadogAPIClient::V2::SecurityMonitoringSignalListRequest](SecurityMonitoringSignalListRequest.md) - - [DatadogAPIClient::V2::SecurityMonitoringSignalListRequestFilter](SecurityMonitoringSignalListRequestFilter.md) - - [DatadogAPIClient::V2::SecurityMonitoringSignalListRequestPage](SecurityMonitoringSignalListRequestPage.md) - - [DatadogAPIClient::V2::SecurityMonitoringSignalType](SecurityMonitoringSignalType.md) - - [DatadogAPIClient::V2::SecurityMonitoringSignalsListResponse](SecurityMonitoringSignalsListResponse.md) - - [DatadogAPIClient::V2::SecurityMonitoringSignalsListResponseLinks](SecurityMonitoringSignalsListResponseLinks.md) - - [DatadogAPIClient::V2::SecurityMonitoringSignalsListResponseMeta](SecurityMonitoringSignalsListResponseMeta.md) - - [DatadogAPIClient::V2::SecurityMonitoringSignalsListResponseMetaPage](SecurityMonitoringSignalsListResponseMetaPage.md) - - [DatadogAPIClient::V2::SecurityMonitoringSignalsSort](SecurityMonitoringSignalsSort.md) - - [DatadogAPIClient::V2::ServiceAccountCreateAttributes](ServiceAccountCreateAttributes.md) - - [DatadogAPIClient::V2::ServiceAccountCreateData](ServiceAccountCreateData.md) - - [DatadogAPIClient::V2::ServiceAccountCreateRequest](ServiceAccountCreateRequest.md) - - [DatadogAPIClient::V2::User](User.md) - - [DatadogAPIClient::V2::UserAttributes](UserAttributes.md) - - [DatadogAPIClient::V2::UserCreateAttributes](UserCreateAttributes.md) - - [DatadogAPIClient::V2::UserCreateData](UserCreateData.md) - - [DatadogAPIClient::V2::UserCreateRequest](UserCreateRequest.md) - - [DatadogAPIClient::V2::UserInvitationData](UserInvitationData.md) - - [DatadogAPIClient::V2::UserInvitationDataAttributes](UserInvitationDataAttributes.md) - - [DatadogAPIClient::V2::UserInvitationRelationships](UserInvitationRelationships.md) - - [DatadogAPIClient::V2::UserInvitationResponse](UserInvitationResponse.md) - - [DatadogAPIClient::V2::UserInvitationResponseData](UserInvitationResponseData.md) - - [DatadogAPIClient::V2::UserInvitationsRequest](UserInvitationsRequest.md) - - [DatadogAPIClient::V2::UserInvitationsResponse](UserInvitationsResponse.md) - - [DatadogAPIClient::V2::UserInvitationsType](UserInvitationsType.md) - - [DatadogAPIClient::V2::UserRelationships](UserRelationships.md) - - [DatadogAPIClient::V2::UserResponse](UserResponse.md) - - [DatadogAPIClient::V2::UserResponseIncludedItem](UserResponseIncludedItem.md) - - [DatadogAPIClient::V2::UserResponseRelationships](UserResponseRelationships.md) - - [DatadogAPIClient::V2::UserUpdateAttributes](UserUpdateAttributes.md) - - [DatadogAPIClient::V2::UserUpdateData](UserUpdateData.md) - - [DatadogAPIClient::V2::UserUpdateRequest](UserUpdateRequest.md) - - [DatadogAPIClient::V2::UsersResponse](UsersResponse.md) - - [DatadogAPIClient::V2::UsersType](UsersType.md) - +- [DatadogAPIClient::V2::APIErrorResponse](APIErrorResponse.md) +- [DatadogAPIClient::V2::APIKeyCreateAttributes](APIKeyCreateAttributes.md) +- [DatadogAPIClient::V2::APIKeyCreateData](APIKeyCreateData.md) +- [DatadogAPIClient::V2::APIKeyCreateRequest](APIKeyCreateRequest.md) +- [DatadogAPIClient::V2::APIKeyRelationships](APIKeyRelationships.md) +- [DatadogAPIClient::V2::APIKeyResponse](APIKeyResponse.md) +- [DatadogAPIClient::V2::APIKeyResponseIncludedItem](APIKeyResponseIncludedItem.md) +- [DatadogAPIClient::V2::APIKeyUpdateAttributes](APIKeyUpdateAttributes.md) +- [DatadogAPIClient::V2::APIKeyUpdateData](APIKeyUpdateData.md) +- [DatadogAPIClient::V2::APIKeyUpdateRequest](APIKeyUpdateRequest.md) +- [DatadogAPIClient::V2::APIKeysResponse](APIKeysResponse.md) +- [DatadogAPIClient::V2::APIKeysSort](APIKeysSort.md) +- [DatadogAPIClient::V2::APIKeysType](APIKeysType.md) +- [DatadogAPIClient::V2::ApplicationKeyCreateAttributes](ApplicationKeyCreateAttributes.md) +- [DatadogAPIClient::V2::ApplicationKeyCreateData](ApplicationKeyCreateData.md) +- [DatadogAPIClient::V2::ApplicationKeyCreateRequest](ApplicationKeyCreateRequest.md) +- [DatadogAPIClient::V2::ApplicationKeyRelationships](ApplicationKeyRelationships.md) +- [DatadogAPIClient::V2::ApplicationKeyResponse](ApplicationKeyResponse.md) +- [DatadogAPIClient::V2::ApplicationKeyResponseIncludedItem](ApplicationKeyResponseIncludedItem.md) +- [DatadogAPIClient::V2::ApplicationKeyUpdateAttributes](ApplicationKeyUpdateAttributes.md) +- [DatadogAPIClient::V2::ApplicationKeyUpdateData](ApplicationKeyUpdateData.md) +- [DatadogAPIClient::V2::ApplicationKeyUpdateRequest](ApplicationKeyUpdateRequest.md) +- [DatadogAPIClient::V2::ApplicationKeysSort](ApplicationKeysSort.md) +- [DatadogAPIClient::V2::ApplicationKeysType](ApplicationKeysType.md) +- [DatadogAPIClient::V2::Creator](Creator.md) +- [DatadogAPIClient::V2::DashboardListAddItemsRequest](DashboardListAddItemsRequest.md) +- [DatadogAPIClient::V2::DashboardListAddItemsResponse](DashboardListAddItemsResponse.md) +- [DatadogAPIClient::V2::DashboardListDeleteItemsRequest](DashboardListDeleteItemsRequest.md) +- [DatadogAPIClient::V2::DashboardListDeleteItemsResponse](DashboardListDeleteItemsResponse.md) +- [DatadogAPIClient::V2::DashboardListItem](DashboardListItem.md) +- [DatadogAPIClient::V2::DashboardListItemRequest](DashboardListItemRequest.md) +- [DatadogAPIClient::V2::DashboardListItemResponse](DashboardListItemResponse.md) +- [DatadogAPIClient::V2::DashboardListItems](DashboardListItems.md) +- [DatadogAPIClient::V2::DashboardListUpdateItemsRequest](DashboardListUpdateItemsRequest.md) +- [DatadogAPIClient::V2::DashboardListUpdateItemsResponse](DashboardListUpdateItemsResponse.md) +- [DatadogAPIClient::V2::DashboardType](DashboardType.md) +- [DatadogAPIClient::V2::FullAPIKey](FullAPIKey.md) +- [DatadogAPIClient::V2::FullAPIKeyAttributes](FullAPIKeyAttributes.md) +- [DatadogAPIClient::V2::FullApplicationKey](FullApplicationKey.md) +- [DatadogAPIClient::V2::FullApplicationKeyAttributes](FullApplicationKeyAttributes.md) +- [DatadogAPIClient::V2::IncidentCreateAttributes](IncidentCreateAttributes.md) +- [DatadogAPIClient::V2::IncidentCreateData](IncidentCreateData.md) +- [DatadogAPIClient::V2::IncidentCreateRelationships](IncidentCreateRelationships.md) +- [DatadogAPIClient::V2::IncidentCreateRequest](IncidentCreateRequest.md) +- [DatadogAPIClient::V2::IncidentFieldAttributes](IncidentFieldAttributes.md) +- [DatadogAPIClient::V2::IncidentFieldAttributesMultipleValue](IncidentFieldAttributesMultipleValue.md) +- [DatadogAPIClient::V2::IncidentFieldAttributesSingleValue](IncidentFieldAttributesSingleValue.md) +- [DatadogAPIClient::V2::IncidentFieldAttributesSingleValueType](IncidentFieldAttributesSingleValueType.md) +- [DatadogAPIClient::V2::IncidentFieldAttributesValueType](IncidentFieldAttributesValueType.md) +- [DatadogAPIClient::V2::IncidentIntegrationMetadataType](IncidentIntegrationMetadataType.md) +- [DatadogAPIClient::V2::IncidentNotificationHandle](IncidentNotificationHandle.md) +- [DatadogAPIClient::V2::IncidentPostmortemType](IncidentPostmortemType.md) +- [DatadogAPIClient::V2::IncidentRelatedObject](IncidentRelatedObject.md) +- [DatadogAPIClient::V2::IncidentResponse](IncidentResponse.md) +- [DatadogAPIClient::V2::IncidentResponseAttributes](IncidentResponseAttributes.md) +- [DatadogAPIClient::V2::IncidentResponseData](IncidentResponseData.md) +- [DatadogAPIClient::V2::IncidentResponseIncludedItem](IncidentResponseIncludedItem.md) +- [DatadogAPIClient::V2::IncidentResponseRelationships](IncidentResponseRelationships.md) +- [DatadogAPIClient::V2::IncidentServiceCreateAttributes](IncidentServiceCreateAttributes.md) +- [DatadogAPIClient::V2::IncidentServiceCreateData](IncidentServiceCreateData.md) +- [DatadogAPIClient::V2::IncidentServiceCreateRequest](IncidentServiceCreateRequest.md) +- [DatadogAPIClient::V2::IncidentServiceIncludedItems](IncidentServiceIncludedItems.md) +- [DatadogAPIClient::V2::IncidentServiceRelationships](IncidentServiceRelationships.md) +- [DatadogAPIClient::V2::IncidentServiceResponse](IncidentServiceResponse.md) +- [DatadogAPIClient::V2::IncidentServiceResponseAttributes](IncidentServiceResponseAttributes.md) +- [DatadogAPIClient::V2::IncidentServiceResponseData](IncidentServiceResponseData.md) +- [DatadogAPIClient::V2::IncidentServiceType](IncidentServiceType.md) +- [DatadogAPIClient::V2::IncidentServiceUpdateAttributes](IncidentServiceUpdateAttributes.md) +- [DatadogAPIClient::V2::IncidentServiceUpdateData](IncidentServiceUpdateData.md) +- [DatadogAPIClient::V2::IncidentServiceUpdateRequest](IncidentServiceUpdateRequest.md) +- [DatadogAPIClient::V2::IncidentServicesResponse](IncidentServicesResponse.md) +- [DatadogAPIClient::V2::IncidentServicesResponseMeta](IncidentServicesResponseMeta.md) +- [DatadogAPIClient::V2::IncidentServicesResponseMetaPagination](IncidentServicesResponseMetaPagination.md) +- [DatadogAPIClient::V2::IncidentTeamCreateAttributes](IncidentTeamCreateAttributes.md) +- [DatadogAPIClient::V2::IncidentTeamCreateData](IncidentTeamCreateData.md) +- [DatadogAPIClient::V2::IncidentTeamCreateRequest](IncidentTeamCreateRequest.md) +- [DatadogAPIClient::V2::IncidentTeamIncludedItems](IncidentTeamIncludedItems.md) +- [DatadogAPIClient::V2::IncidentTeamRelationships](IncidentTeamRelationships.md) +- [DatadogAPIClient::V2::IncidentTeamResponse](IncidentTeamResponse.md) +- [DatadogAPIClient::V2::IncidentTeamResponseAttributes](IncidentTeamResponseAttributes.md) +- [DatadogAPIClient::V2::IncidentTeamResponseData](IncidentTeamResponseData.md) +- [DatadogAPIClient::V2::IncidentTeamType](IncidentTeamType.md) +- [DatadogAPIClient::V2::IncidentTeamUpdateAttributes](IncidentTeamUpdateAttributes.md) +- [DatadogAPIClient::V2::IncidentTeamUpdateData](IncidentTeamUpdateData.md) +- [DatadogAPIClient::V2::IncidentTeamUpdateRequest](IncidentTeamUpdateRequest.md) +- [DatadogAPIClient::V2::IncidentTeamsResponse](IncidentTeamsResponse.md) +- [DatadogAPIClient::V2::IncidentTimelineCellCreateAttributes](IncidentTimelineCellCreateAttributes.md) +- [DatadogAPIClient::V2::IncidentTimelineCellMarkdownContentType](IncidentTimelineCellMarkdownContentType.md) +- [DatadogAPIClient::V2::IncidentTimelineCellMarkdownCreateAttributes](IncidentTimelineCellMarkdownCreateAttributes.md) +- [DatadogAPIClient::V2::IncidentTimelineCellMarkdownCreateAttributesContent](IncidentTimelineCellMarkdownCreateAttributesContent.md) +- [DatadogAPIClient::V2::IncidentType](IncidentType.md) +- [DatadogAPIClient::V2::IncidentUpdateAttributes](IncidentUpdateAttributes.md) +- [DatadogAPIClient::V2::IncidentUpdateData](IncidentUpdateData.md) +- [DatadogAPIClient::V2::IncidentUpdateRelationships](IncidentUpdateRelationships.md) +- [DatadogAPIClient::V2::IncidentUpdateRequest](IncidentUpdateRequest.md) +- [DatadogAPIClient::V2::IncidentsResponse](IncidentsResponse.md) +- [DatadogAPIClient::V2::ListApplicationKeysResponse](ListApplicationKeysResponse.md) +- [DatadogAPIClient::V2::Log](Log.md) +- [DatadogAPIClient::V2::LogAttributes](LogAttributes.md) +- [DatadogAPIClient::V2::LogType](LogType.md) +- [DatadogAPIClient::V2::LogsAggregateBucket](LogsAggregateBucket.md) +- [DatadogAPIClient::V2::LogsAggregateBucketValue](LogsAggregateBucketValue.md) +- [DatadogAPIClient::V2::LogsAggregateBucketValueTimeseriesPoint](LogsAggregateBucketValueTimeseriesPoint.md) +- [DatadogAPIClient::V2::LogsAggregateRequest](LogsAggregateRequest.md) +- [DatadogAPIClient::V2::LogsAggregateRequestPage](LogsAggregateRequestPage.md) +- [DatadogAPIClient::V2::LogsAggregateResponse](LogsAggregateResponse.md) +- [DatadogAPIClient::V2::LogsAggregateResponseData](LogsAggregateResponseData.md) +- [DatadogAPIClient::V2::LogsAggregateResponseStatus](LogsAggregateResponseStatus.md) +- [DatadogAPIClient::V2::LogsAggregateSort](LogsAggregateSort.md) +- [DatadogAPIClient::V2::LogsAggregateSortType](LogsAggregateSortType.md) +- [DatadogAPIClient::V2::LogsAggregationFunction](LogsAggregationFunction.md) +- [DatadogAPIClient::V2::LogsArchive](LogsArchive.md) +- [DatadogAPIClient::V2::LogsArchiveAttributes](LogsArchiveAttributes.md) +- [DatadogAPIClient::V2::LogsArchiveCreateRequest](LogsArchiveCreateRequest.md) +- [DatadogAPIClient::V2::LogsArchiveCreateRequestAttributes](LogsArchiveCreateRequestAttributes.md) +- [DatadogAPIClient::V2::LogsArchiveCreateRequestDefinition](LogsArchiveCreateRequestDefinition.md) +- [DatadogAPIClient::V2::LogsArchiveCreateRequestDestination](LogsArchiveCreateRequestDestination.md) +- [DatadogAPIClient::V2::LogsArchiveDefinition](LogsArchiveDefinition.md) +- [DatadogAPIClient::V2::LogsArchiveDestination](LogsArchiveDestination.md) +- [DatadogAPIClient::V2::LogsArchiveDestinationAzure](LogsArchiveDestinationAzure.md) +- [DatadogAPIClient::V2::LogsArchiveDestinationAzureType](LogsArchiveDestinationAzureType.md) +- [DatadogAPIClient::V2::LogsArchiveDestinationGCS](LogsArchiveDestinationGCS.md) +- [DatadogAPIClient::V2::LogsArchiveDestinationGCSType](LogsArchiveDestinationGCSType.md) +- [DatadogAPIClient::V2::LogsArchiveDestinationS3](LogsArchiveDestinationS3.md) +- [DatadogAPIClient::V2::LogsArchiveDestinationS3Type](LogsArchiveDestinationS3Type.md) +- [DatadogAPIClient::V2::LogsArchiveIntegrationAzure](LogsArchiveIntegrationAzure.md) +- [DatadogAPIClient::V2::LogsArchiveIntegrationGCS](LogsArchiveIntegrationGCS.md) +- [DatadogAPIClient::V2::LogsArchiveIntegrationS3](LogsArchiveIntegrationS3.md) +- [DatadogAPIClient::V2::LogsArchiveOrder](LogsArchiveOrder.md) +- [DatadogAPIClient::V2::LogsArchiveOrderAttributes](LogsArchiveOrderAttributes.md) +- [DatadogAPIClient::V2::LogsArchiveOrderDefinition](LogsArchiveOrderDefinition.md) +- [DatadogAPIClient::V2::LogsArchiveOrderDefinitionType](LogsArchiveOrderDefinitionType.md) +- [DatadogAPIClient::V2::LogsArchiveState](LogsArchiveState.md) +- [DatadogAPIClient::V2::LogsArchives](LogsArchives.md) +- [DatadogAPIClient::V2::LogsCompute](LogsCompute.md) +- [DatadogAPIClient::V2::LogsComputeType](LogsComputeType.md) +- [DatadogAPIClient::V2::LogsGroupBy](LogsGroupBy.md) +- [DatadogAPIClient::V2::LogsGroupByHistogram](LogsGroupByHistogram.md) +- [DatadogAPIClient::V2::LogsGroupByMissing](LogsGroupByMissing.md) +- [DatadogAPIClient::V2::LogsGroupByTotal](LogsGroupByTotal.md) +- [DatadogAPIClient::V2::LogsListRequest](LogsListRequest.md) +- [DatadogAPIClient::V2::LogsListRequestPage](LogsListRequestPage.md) +- [DatadogAPIClient::V2::LogsListResponse](LogsListResponse.md) +- [DatadogAPIClient::V2::LogsListResponseLinks](LogsListResponseLinks.md) +- [DatadogAPIClient::V2::LogsMetricCompute](LogsMetricCompute.md) +- [DatadogAPIClient::V2::LogsMetricComputeAggregationType](LogsMetricComputeAggregationType.md) +- [DatadogAPIClient::V2::LogsMetricCreateAttributes](LogsMetricCreateAttributes.md) +- [DatadogAPIClient::V2::LogsMetricCreateData](LogsMetricCreateData.md) +- [DatadogAPIClient::V2::LogsMetricCreateRequest](LogsMetricCreateRequest.md) +- [DatadogAPIClient::V2::LogsMetricFilter](LogsMetricFilter.md) +- [DatadogAPIClient::V2::LogsMetricGroupBy](LogsMetricGroupBy.md) +- [DatadogAPIClient::V2::LogsMetricResponse](LogsMetricResponse.md) +- [DatadogAPIClient::V2::LogsMetricResponseAttributes](LogsMetricResponseAttributes.md) +- [DatadogAPIClient::V2::LogsMetricResponseCompute](LogsMetricResponseCompute.md) +- [DatadogAPIClient::V2::LogsMetricResponseComputeAggregationType](LogsMetricResponseComputeAggregationType.md) +- [DatadogAPIClient::V2::LogsMetricResponseData](LogsMetricResponseData.md) +- [DatadogAPIClient::V2::LogsMetricResponseFilter](LogsMetricResponseFilter.md) +- [DatadogAPIClient::V2::LogsMetricResponseGroupBy](LogsMetricResponseGroupBy.md) +- [DatadogAPIClient::V2::LogsMetricType](LogsMetricType.md) +- [DatadogAPIClient::V2::LogsMetricUpdateAttributes](LogsMetricUpdateAttributes.md) +- [DatadogAPIClient::V2::LogsMetricUpdateData](LogsMetricUpdateData.md) +- [DatadogAPIClient::V2::LogsMetricUpdateRequest](LogsMetricUpdateRequest.md) +- [DatadogAPIClient::V2::LogsMetricsResponse](LogsMetricsResponse.md) +- [DatadogAPIClient::V2::LogsQueryFilter](LogsQueryFilter.md) +- [DatadogAPIClient::V2::LogsQueryOptions](LogsQueryOptions.md) +- [DatadogAPIClient::V2::LogsResponseMetadata](LogsResponseMetadata.md) +- [DatadogAPIClient::V2::LogsResponseMetadataPage](LogsResponseMetadataPage.md) +- [DatadogAPIClient::V2::LogsSort](LogsSort.md) +- [DatadogAPIClient::V2::LogsSortOrder](LogsSortOrder.md) +- [DatadogAPIClient::V2::LogsWarning](LogsWarning.md) +- [DatadogAPIClient::V2::Metric](Metric.md) +- [DatadogAPIClient::V2::MetricAllTags](MetricAllTags.md) +- [DatadogAPIClient::V2::MetricAllTagsAttributes](MetricAllTagsAttributes.md) +- [DatadogAPIClient::V2::MetricAllTagsResponse](MetricAllTagsResponse.md) +- [DatadogAPIClient::V2::MetricCustomAggregation](MetricCustomAggregation.md) +- [DatadogAPIClient::V2::MetricCustomSpaceAggregation](MetricCustomSpaceAggregation.md) +- [DatadogAPIClient::V2::MetricCustomTimeAggregation](MetricCustomTimeAggregation.md) +- [DatadogAPIClient::V2::MetricDistinctVolume](MetricDistinctVolume.md) +- [DatadogAPIClient::V2::MetricDistinctVolumeAttributes](MetricDistinctVolumeAttributes.md) +- [DatadogAPIClient::V2::MetricDistinctVolumeType](MetricDistinctVolumeType.md) +- [DatadogAPIClient::V2::MetricIngestedIndexedVolume](MetricIngestedIndexedVolume.md) +- [DatadogAPIClient::V2::MetricIngestedIndexedVolumeAttributes](MetricIngestedIndexedVolumeAttributes.md) +- [DatadogAPIClient::V2::MetricIngestedIndexedVolumeType](MetricIngestedIndexedVolumeType.md) +- [DatadogAPIClient::V2::MetricTagConfiguration](MetricTagConfiguration.md) +- [DatadogAPIClient::V2::MetricTagConfigurationAttributes](MetricTagConfigurationAttributes.md) +- [DatadogAPIClient::V2::MetricTagConfigurationCreateAttributes](MetricTagConfigurationCreateAttributes.md) +- [DatadogAPIClient::V2::MetricTagConfigurationCreateData](MetricTagConfigurationCreateData.md) +- [DatadogAPIClient::V2::MetricTagConfigurationCreateRequest](MetricTagConfigurationCreateRequest.md) +- [DatadogAPIClient::V2::MetricTagConfigurationMetricTypes](MetricTagConfigurationMetricTypes.md) +- [DatadogAPIClient::V2::MetricTagConfigurationResponse](MetricTagConfigurationResponse.md) +- [DatadogAPIClient::V2::MetricTagConfigurationType](MetricTagConfigurationType.md) +- [DatadogAPIClient::V2::MetricTagConfigurationUpdateAttributes](MetricTagConfigurationUpdateAttributes.md) +- [DatadogAPIClient::V2::MetricTagConfigurationUpdateData](MetricTagConfigurationUpdateData.md) +- [DatadogAPIClient::V2::MetricTagConfigurationUpdateRequest](MetricTagConfigurationUpdateRequest.md) +- [DatadogAPIClient::V2::MetricType](MetricType.md) +- [DatadogAPIClient::V2::MetricVolumes](MetricVolumes.md) +- [DatadogAPIClient::V2::MetricVolumesResponse](MetricVolumesResponse.md) +- [DatadogAPIClient::V2::MetricsAndMetricTagConfigurations](MetricsAndMetricTagConfigurations.md) +- [DatadogAPIClient::V2::MetricsAndMetricTagConfigurationsResponse](MetricsAndMetricTagConfigurationsResponse.md) +- [DatadogAPIClient::V2::Organization](Organization.md) +- [DatadogAPIClient::V2::OrganizationAttributes](OrganizationAttributes.md) +- [DatadogAPIClient::V2::OrganizationsType](OrganizationsType.md) +- [DatadogAPIClient::V2::Pagination](Pagination.md) +- [DatadogAPIClient::V2::PartialAPIKey](PartialAPIKey.md) +- [DatadogAPIClient::V2::PartialAPIKeyAttributes](PartialAPIKeyAttributes.md) +- [DatadogAPIClient::V2::PartialApplicationKey](PartialApplicationKey.md) +- [DatadogAPIClient::V2::PartialApplicationKeyAttributes](PartialApplicationKeyAttributes.md) +- [DatadogAPIClient::V2::PartialApplicationKeyResponse](PartialApplicationKeyResponse.md) +- [DatadogAPIClient::V2::Permission](Permission.md) +- [DatadogAPIClient::V2::PermissionAttributes](PermissionAttributes.md) +- [DatadogAPIClient::V2::PermissionsResponse](PermissionsResponse.md) +- [DatadogAPIClient::V2::PermissionsType](PermissionsType.md) +- [DatadogAPIClient::V2::ProcessSummariesMeta](ProcessSummariesMeta.md) +- [DatadogAPIClient::V2::ProcessSummariesMetaPage](ProcessSummariesMetaPage.md) +- [DatadogAPIClient::V2::ProcessSummariesResponse](ProcessSummariesResponse.md) +- [DatadogAPIClient::V2::ProcessSummary](ProcessSummary.md) +- [DatadogAPIClient::V2::ProcessSummaryAttributes](ProcessSummaryAttributes.md) +- [DatadogAPIClient::V2::ProcessSummaryType](ProcessSummaryType.md) +- [DatadogAPIClient::V2::QuerySortOrder](QuerySortOrder.md) +- [DatadogAPIClient::V2::RelationshipToIncidentIntegrationMetadataData](RelationshipToIncidentIntegrationMetadataData.md) +- [DatadogAPIClient::V2::RelationshipToIncidentIntegrationMetadatas](RelationshipToIncidentIntegrationMetadatas.md) +- [DatadogAPIClient::V2::RelationshipToIncidentPostmortem](RelationshipToIncidentPostmortem.md) +- [DatadogAPIClient::V2::RelationshipToIncidentPostmortemData](RelationshipToIncidentPostmortemData.md) +- [DatadogAPIClient::V2::RelationshipToOrganization](RelationshipToOrganization.md) +- [DatadogAPIClient::V2::RelationshipToOrganizationData](RelationshipToOrganizationData.md) +- [DatadogAPIClient::V2::RelationshipToOrganizations](RelationshipToOrganizations.md) +- [DatadogAPIClient::V2::RelationshipToPermission](RelationshipToPermission.md) +- [DatadogAPIClient::V2::RelationshipToPermissionData](RelationshipToPermissionData.md) +- [DatadogAPIClient::V2::RelationshipToPermissions](RelationshipToPermissions.md) +- [DatadogAPIClient::V2::RelationshipToRole](RelationshipToRole.md) +- [DatadogAPIClient::V2::RelationshipToRoleData](RelationshipToRoleData.md) +- [DatadogAPIClient::V2::RelationshipToRoles](RelationshipToRoles.md) +- [DatadogAPIClient::V2::RelationshipToUser](RelationshipToUser.md) +- [DatadogAPIClient::V2::RelationshipToUserData](RelationshipToUserData.md) +- [DatadogAPIClient::V2::RelationshipToUsers](RelationshipToUsers.md) +- [DatadogAPIClient::V2::ResponseMetaAttributes](ResponseMetaAttributes.md) +- [DatadogAPIClient::V2::Role](Role.md) +- [DatadogAPIClient::V2::RoleAttributes](RoleAttributes.md) +- [DatadogAPIClient::V2::RoleCreateAttributes](RoleCreateAttributes.md) +- [DatadogAPIClient::V2::RoleCreateData](RoleCreateData.md) +- [DatadogAPIClient::V2::RoleCreateRequest](RoleCreateRequest.md) +- [DatadogAPIClient::V2::RoleCreateResponse](RoleCreateResponse.md) +- [DatadogAPIClient::V2::RoleCreateResponseData](RoleCreateResponseData.md) +- [DatadogAPIClient::V2::RoleRelationships](RoleRelationships.md) +- [DatadogAPIClient::V2::RoleResponse](RoleResponse.md) +- [DatadogAPIClient::V2::RoleResponseRelationships](RoleResponseRelationships.md) +- [DatadogAPIClient::V2::RoleUpdateAttributes](RoleUpdateAttributes.md) +- [DatadogAPIClient::V2::RoleUpdateData](RoleUpdateData.md) +- [DatadogAPIClient::V2::RoleUpdateRequest](RoleUpdateRequest.md) +- [DatadogAPIClient::V2::RoleUpdateResponse](RoleUpdateResponse.md) +- [DatadogAPIClient::V2::RoleUpdateResponseData](RoleUpdateResponseData.md) +- [DatadogAPIClient::V2::RolesResponse](RolesResponse.md) +- [DatadogAPIClient::V2::RolesSort](RolesSort.md) +- [DatadogAPIClient::V2::RolesType](RolesType.md) +- [DatadogAPIClient::V2::SecurityFilter](SecurityFilter.md) +- [DatadogAPIClient::V2::SecurityFilterAttributes](SecurityFilterAttributes.md) +- [DatadogAPIClient::V2::SecurityFilterCreateAttributes](SecurityFilterCreateAttributes.md) +- [DatadogAPIClient::V2::SecurityFilterCreateData](SecurityFilterCreateData.md) +- [DatadogAPIClient::V2::SecurityFilterCreateRequest](SecurityFilterCreateRequest.md) +- [DatadogAPIClient::V2::SecurityFilterExclusionFilter](SecurityFilterExclusionFilter.md) +- [DatadogAPIClient::V2::SecurityFilterExclusionFilterResponse](SecurityFilterExclusionFilterResponse.md) +- [DatadogAPIClient::V2::SecurityFilterFilteredDataType](SecurityFilterFilteredDataType.md) +- [DatadogAPIClient::V2::SecurityFilterMeta](SecurityFilterMeta.md) +- [DatadogAPIClient::V2::SecurityFilterResponse](SecurityFilterResponse.md) +- [DatadogAPIClient::V2::SecurityFilterType](SecurityFilterType.md) +- [DatadogAPIClient::V2::SecurityFilterUpdateAttributes](SecurityFilterUpdateAttributes.md) +- [DatadogAPIClient::V2::SecurityFilterUpdateData](SecurityFilterUpdateData.md) +- [DatadogAPIClient::V2::SecurityFilterUpdateRequest](SecurityFilterUpdateRequest.md) +- [DatadogAPIClient::V2::SecurityFiltersResponse](SecurityFiltersResponse.md) +- [DatadogAPIClient::V2::SecurityMonitoringFilter](SecurityMonitoringFilter.md) +- [DatadogAPIClient::V2::SecurityMonitoringFilterAction](SecurityMonitoringFilterAction.md) +- [DatadogAPIClient::V2::SecurityMonitoringListRulesResponse](SecurityMonitoringListRulesResponse.md) +- [DatadogAPIClient::V2::SecurityMonitoringRuleCase](SecurityMonitoringRuleCase.md) +- [DatadogAPIClient::V2::SecurityMonitoringRuleCaseCreate](SecurityMonitoringRuleCaseCreate.md) +- [DatadogAPIClient::V2::SecurityMonitoringRuleCreatePayload](SecurityMonitoringRuleCreatePayload.md) +- [DatadogAPIClient::V2::SecurityMonitoringRuleDetectionMethod](SecurityMonitoringRuleDetectionMethod.md) +- [DatadogAPIClient::V2::SecurityMonitoringRuleEvaluationWindow](SecurityMonitoringRuleEvaluationWindow.md) +- [DatadogAPIClient::V2::SecurityMonitoringRuleKeepAlive](SecurityMonitoringRuleKeepAlive.md) +- [DatadogAPIClient::V2::SecurityMonitoringRuleMaxSignalDuration](SecurityMonitoringRuleMaxSignalDuration.md) +- [DatadogAPIClient::V2::SecurityMonitoringRuleNewValueOptions](SecurityMonitoringRuleNewValueOptions.md) +- [DatadogAPIClient::V2::SecurityMonitoringRuleNewValueOptionsForgetAfter](SecurityMonitoringRuleNewValueOptionsForgetAfter.md) +- [DatadogAPIClient::V2::SecurityMonitoringRuleNewValueOptionsLearningDuration](SecurityMonitoringRuleNewValueOptionsLearningDuration.md) +- [DatadogAPIClient::V2::SecurityMonitoringRuleOptions](SecurityMonitoringRuleOptions.md) +- [DatadogAPIClient::V2::SecurityMonitoringRuleQuery](SecurityMonitoringRuleQuery.md) +- [DatadogAPIClient::V2::SecurityMonitoringRuleQueryAggregation](SecurityMonitoringRuleQueryAggregation.md) +- [DatadogAPIClient::V2::SecurityMonitoringRuleQueryCreate](SecurityMonitoringRuleQueryCreate.md) +- [DatadogAPIClient::V2::SecurityMonitoringRuleResponse](SecurityMonitoringRuleResponse.md) +- [DatadogAPIClient::V2::SecurityMonitoringRuleSeverity](SecurityMonitoringRuleSeverity.md) +- [DatadogAPIClient::V2::SecurityMonitoringRuleTypeCreate](SecurityMonitoringRuleTypeCreate.md) +- [DatadogAPIClient::V2::SecurityMonitoringRuleTypeRead](SecurityMonitoringRuleTypeRead.md) +- [DatadogAPIClient::V2::SecurityMonitoringRuleUpdatePayload](SecurityMonitoringRuleUpdatePayload.md) +- [DatadogAPIClient::V2::SecurityMonitoringRuntimeAgentRule](SecurityMonitoringRuntimeAgentRule.md) +- [DatadogAPIClient::V2::SecurityMonitoringSignal](SecurityMonitoringSignal.md) +- [DatadogAPIClient::V2::SecurityMonitoringSignalAttributes](SecurityMonitoringSignalAttributes.md) +- [DatadogAPIClient::V2::SecurityMonitoringSignalListRequest](SecurityMonitoringSignalListRequest.md) +- [DatadogAPIClient::V2::SecurityMonitoringSignalListRequestFilter](SecurityMonitoringSignalListRequestFilter.md) +- [DatadogAPIClient::V2::SecurityMonitoringSignalListRequestPage](SecurityMonitoringSignalListRequestPage.md) +- [DatadogAPIClient::V2::SecurityMonitoringSignalType](SecurityMonitoringSignalType.md) +- [DatadogAPIClient::V2::SecurityMonitoringSignalsListResponse](SecurityMonitoringSignalsListResponse.md) +- [DatadogAPIClient::V2::SecurityMonitoringSignalsListResponseLinks](SecurityMonitoringSignalsListResponseLinks.md) +- [DatadogAPIClient::V2::SecurityMonitoringSignalsListResponseMeta](SecurityMonitoringSignalsListResponseMeta.md) +- [DatadogAPIClient::V2::SecurityMonitoringSignalsListResponseMetaPage](SecurityMonitoringSignalsListResponseMetaPage.md) +- [DatadogAPIClient::V2::SecurityMonitoringSignalsSort](SecurityMonitoringSignalsSort.md) +- [DatadogAPIClient::V2::ServiceAccountCreateAttributes](ServiceAccountCreateAttributes.md) +- [DatadogAPIClient::V2::ServiceAccountCreateData](ServiceAccountCreateData.md) +- [DatadogAPIClient::V2::ServiceAccountCreateRequest](ServiceAccountCreateRequest.md) +- [DatadogAPIClient::V2::User](User.md) +- [DatadogAPIClient::V2::UserAttributes](UserAttributes.md) +- [DatadogAPIClient::V2::UserCreateAttributes](UserCreateAttributes.md) +- [DatadogAPIClient::V2::UserCreateData](UserCreateData.md) +- [DatadogAPIClient::V2::UserCreateRequest](UserCreateRequest.md) +- [DatadogAPIClient::V2::UserInvitationData](UserInvitationData.md) +- [DatadogAPIClient::V2::UserInvitationDataAttributes](UserInvitationDataAttributes.md) +- [DatadogAPIClient::V2::UserInvitationRelationships](UserInvitationRelationships.md) +- [DatadogAPIClient::V2::UserInvitationResponse](UserInvitationResponse.md) +- [DatadogAPIClient::V2::UserInvitationResponseData](UserInvitationResponseData.md) +- [DatadogAPIClient::V2::UserInvitationsRequest](UserInvitationsRequest.md) +- [DatadogAPIClient::V2::UserInvitationsResponse](UserInvitationsResponse.md) +- [DatadogAPIClient::V2::UserInvitationsType](UserInvitationsType.md) +- [DatadogAPIClient::V2::UserRelationships](UserRelationships.md) +- [DatadogAPIClient::V2::UserResponse](UserResponse.md) +- [DatadogAPIClient::V2::UserResponseIncludedItem](UserResponseIncludedItem.md) +- [DatadogAPIClient::V2::UserResponseRelationships](UserResponseRelationships.md) +- [DatadogAPIClient::V2::UserUpdateAttributes](UserUpdateAttributes.md) +- [DatadogAPIClient::V2::UserUpdateData](UserUpdateData.md) +- [DatadogAPIClient::V2::UserUpdateRequest](UserUpdateRequest.md) +- [DatadogAPIClient::V2::UsersResponse](UsersResponse.md) +- [DatadogAPIClient::V2::UsersType](UsersType.md) ## Documentation for Authorization - ### AuthZ - - **Type**: OAuth - **Flow**: accessCode - **Authorization URL**: /oauth2/v1/authorize -- **Scopes**: +- **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. @@ -492,15 +488,12 @@ Class | Method | HTTP request | Description ### apiKeyAuth - - **Type**: API key - **API key parameter name**: DD-API-KEY - **Location**: HTTP header ### appKeyAuth - - **Type**: API key - **API key parameter name**: DD-APPLICATION-KEY - **Location**: HTTP header - diff --git a/docs/v2/RelationshipToIncidentIntegrationMetadataData.md b/docs/v2/RelationshipToIncidentIntegrationMetadataData.md index 2ce309377f4b..2c186abfe68c 100644 --- a/docs/v2/RelationshipToIncidentIntegrationMetadataData.md +++ b/docs/v2/RelationshipToIncidentIntegrationMetadataData.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **id** | **String** | A unique identifier that represents the integration metadata. | | -| **type** | [**IncidentIntegrationMetadataType**](IncidentIntegrationMetadataType.md) | | [default to 'incident_integrations'] | +| Name | Type | Description | Notes | +| -------- | ------------------------------------------------------------------------- | ------------------------------------------------------------- | -------------------------------------------- | +| **id** | **String** | A unique identifier that represents the integration metadata. | | +| **type** | [**IncidentIntegrationMetadataType**](IncidentIntegrationMetadataType.md) | | [default to 'incident_integrations'] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::RelationshipToIncidentIntegrationMetadataData.n type: null ) ``` - diff --git a/docs/v2/RelationshipToIncidentIntegrationMetadatas.md b/docs/v2/RelationshipToIncidentIntegrationMetadatas.md index 360943c26245..4db971b80c09 100644 --- a/docs/v2/RelationshipToIncidentIntegrationMetadatas.md +++ b/docs/v2/RelationshipToIncidentIntegrationMetadatas.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**Array<RelationshipToIncidentIntegrationMetadataData>**](RelationshipToIncidentIntegrationMetadataData.md) | The integration metadata relationship array | | +| Name | Type | Description | Notes | +| -------- | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------- | ----- | +| **data** | [**Array<RelationshipToIncidentIntegrationMetadataData>**](RelationshipToIncidentIntegrationMetadataData.md) | The integration metadata relationship array | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::RelationshipToIncidentIntegrationMetadatas.new( data: [{"id":"00000000-0000-0000-0000-000000000000","type":"incident_integrations"},{"id":"00000000-0000-0000-0000-000000000000","type":"incident_integrations"}] ) ``` - diff --git a/docs/v2/RelationshipToIncidentPostmortem.md b/docs/v2/RelationshipToIncidentPostmortem.md index 9272ae29454a..38f09e82f60b 100644 --- a/docs/v2/RelationshipToIncidentPostmortem.md +++ b/docs/v2/RelationshipToIncidentPostmortem.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**RelationshipToIncidentPostmortemData**](RelationshipToIncidentPostmortemData.md) | | | +| Name | Type | Description | Notes | +| -------- | ----------------------------------------------------------------------------------- | ----------- | ----- | +| **data** | [**RelationshipToIncidentPostmortemData**](RelationshipToIncidentPostmortemData.md) | | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::RelationshipToIncidentPostmortem.new( data: null ) ``` - diff --git a/docs/v2/RelationshipToIncidentPostmortemData.md b/docs/v2/RelationshipToIncidentPostmortemData.md index c2e5e9007acf..831a1150e5c5 100644 --- a/docs/v2/RelationshipToIncidentPostmortemData.md +++ b/docs/v2/RelationshipToIncidentPostmortemData.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **id** | **String** | A unique identifier that represents the postmortem. | | -| **type** | [**IncidentPostmortemType**](IncidentPostmortemType.md) | | [default to 'incident_postmortems'] | +| Name | Type | Description | Notes | +| -------- | ------------------------------------------------------- | --------------------------------------------------- | ------------------------------------------- | +| **id** | **String** | A unique identifier that represents the postmortem. | | +| **type** | [**IncidentPostmortemType**](IncidentPostmortemType.md) | | [default to 'incident_postmortems'] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::RelationshipToIncidentPostmortemData.new( type: null ) ``` - diff --git a/docs/v2/RelationshipToOrganization.md b/docs/v2/RelationshipToOrganization.md index b47c9b27e4da..55f9ec407239 100644 --- a/docs/v2/RelationshipToOrganization.md +++ b/docs/v2/RelationshipToOrganization.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**RelationshipToOrganizationData**](RelationshipToOrganizationData.md) | | | +| Name | Type | Description | Notes | +| -------- | ----------------------------------------------------------------------- | ----------- | ----- | +| **data** | [**RelationshipToOrganizationData**](RelationshipToOrganizationData.md) | | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::RelationshipToOrganization.new( data: null ) ``` - diff --git a/docs/v2/RelationshipToOrganizationData.md b/docs/v2/RelationshipToOrganizationData.md index 506b857ccf38..eeb7ec771052 100644 --- a/docs/v2/RelationshipToOrganizationData.md +++ b/docs/v2/RelationshipToOrganizationData.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **id** | **String** | ID of the organization. | | -| **type** | [**OrganizationsType**](OrganizationsType.md) | | [default to 'orgs'] | +| Name | Type | Description | Notes | +| -------- | --------------------------------------------- | ----------------------- | --------------------------- | +| **id** | **String** | ID of the organization. | | +| **type** | [**OrganizationsType**](OrganizationsType.md) | | [default to 'orgs'] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::RelationshipToOrganizationData.new( type: null ) ``` - diff --git a/docs/v2/RelationshipToOrganizations.md b/docs/v2/RelationshipToOrganizations.md index 1770544b59d0..9c9ee83d1917 100644 --- a/docs/v2/RelationshipToOrganizations.md +++ b/docs/v2/RelationshipToOrganizations.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**Array<RelationshipToOrganizationData>**](RelationshipToOrganizationData.md) | Relationships to organization objects. | | +| Name | Type | Description | Notes | +| -------- | ------------------------------------------------------------------------------------ | -------------------------------------- | ----- | +| **data** | [**Array<RelationshipToOrganizationData>**](RelationshipToOrganizationData.md) | Relationships to organization objects. | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::RelationshipToOrganizations.new( data: [] ) ``` - diff --git a/docs/v2/RelationshipToPermission.md b/docs/v2/RelationshipToPermission.md index 224d10671ff8..0bc2d5702f24 100644 --- a/docs/v2/RelationshipToPermission.md +++ b/docs/v2/RelationshipToPermission.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**RelationshipToPermissionData**](RelationshipToPermissionData.md) | | [optional] | +| Name | Type | Description | Notes | +| -------- | ------------------------------------------------------------------- | ----------- | ---------- | +| **data** | [**RelationshipToPermissionData**](RelationshipToPermissionData.md) | | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::RelationshipToPermission.new( data: null ) ``` - diff --git a/docs/v2/RelationshipToPermissionData.md b/docs/v2/RelationshipToPermissionData.md index 79e370178090..f785cf2027da 100644 --- a/docs/v2/RelationshipToPermissionData.md +++ b/docs/v2/RelationshipToPermissionData.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **id** | **String** | ID of the permission. | [optional] | -| **type** | [**PermissionsType**](PermissionsType.md) | | [optional][default to 'permissions'] | +| Name | Type | Description | Notes | +| -------- | ----------------------------------------- | --------------------- | -------------------------------------------- | +| **id** | **String** | ID of the permission. | [optional] | +| **type** | [**PermissionsType**](PermissionsType.md) | | [optional][default to 'permissions'] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::RelationshipToPermissionData.new( type: null ) ``` - diff --git a/docs/v2/RelationshipToPermissions.md b/docs/v2/RelationshipToPermissions.md index 109109abadee..19d138c43604 100644 --- a/docs/v2/RelationshipToPermissions.md +++ b/docs/v2/RelationshipToPermissions.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| -------- | -------------------------------------------------------------------------------- | ------------------------------------ | ---------- | | **data** | [**Array<RelationshipToPermissionData>**](RelationshipToPermissionData.md) | Relationships to permission objects. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::RelationshipToPermissions.new( data: null ) ``` - diff --git a/docs/v2/RelationshipToRole.md b/docs/v2/RelationshipToRole.md index 85cfe646afaf..92f2006cc149 100644 --- a/docs/v2/RelationshipToRole.md +++ b/docs/v2/RelationshipToRole.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**RelationshipToRoleData**](RelationshipToRoleData.md) | | [optional] | +| Name | Type | Description | Notes | +| -------- | ------------------------------------------------------- | ----------- | ---------- | +| **data** | [**RelationshipToRoleData**](RelationshipToRoleData.md) | | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::RelationshipToRole.new( data: null ) ``` - diff --git a/docs/v2/RelationshipToRoleData.md b/docs/v2/RelationshipToRoleData.md index 2751645d9ecf..5b2f5ec121ec 100644 --- a/docs/v2/RelationshipToRoleData.md +++ b/docs/v2/RelationshipToRoleData.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **id** | **String** | ID of the role. | [optional] | -| **type** | [**RolesType**](RolesType.md) | | [optional][default to 'roles'] | +| Name | Type | Description | Notes | +| -------- | ----------------------------- | --------------- | -------------------------------------- | +| **id** | **String** | ID of the role. | [optional] | +| **type** | [**RolesType**](RolesType.md) | | [optional][default to 'roles'] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::RelationshipToRoleData.new( type: null ) ``` - diff --git a/docs/v2/RelationshipToRoles.md b/docs/v2/RelationshipToRoles.md index 73e16865ccdb..b5c98df2ae7e 100644 --- a/docs/v2/RelationshipToRoles.md +++ b/docs/v2/RelationshipToRoles.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| -------- | -------------------------------------------------------------------- | ------------------------------------------ | ---------- | | **data** | [**Array<RelationshipToRoleData>**](RelationshipToRoleData.md) | An array containing type and ID of a role. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::RelationshipToRoles.new( data: null ) ``` - diff --git a/docs/v2/RelationshipToUser.md b/docs/v2/RelationshipToUser.md index 81aaddd26610..9151adbd0650 100644 --- a/docs/v2/RelationshipToUser.md +++ b/docs/v2/RelationshipToUser.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**RelationshipToUserData**](RelationshipToUserData.md) | | | +| Name | Type | Description | Notes | +| -------- | ------------------------------------------------------- | ----------- | ----- | +| **data** | [**RelationshipToUserData**](RelationshipToUserData.md) | | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::RelationshipToUser.new( data: null ) ``` - diff --git a/docs/v2/RelationshipToUserData.md b/docs/v2/RelationshipToUserData.md index c5ebf62f3e47..2e85a5e6d939 100644 --- a/docs/v2/RelationshipToUserData.md +++ b/docs/v2/RelationshipToUserData.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **id** | **String** | A unique identifier that represents the user. | | -| **type** | [**UsersType**](UsersType.md) | | [default to 'users'] | +| Name | Type | Description | Notes | +| -------- | ----------------------------- | --------------------------------------------- | ---------------------------- | +| **id** | **String** | A unique identifier that represents the user. | | +| **type** | [**UsersType**](UsersType.md) | | [default to 'users'] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::RelationshipToUserData.new( type: null ) ``` - diff --git a/docs/v2/RelationshipToUsers.md b/docs/v2/RelationshipToUsers.md index c8759c308a02..c905eb0a2759 100644 --- a/docs/v2/RelationshipToUsers.md +++ b/docs/v2/RelationshipToUsers.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**Array<RelationshipToUserData>**](RelationshipToUserData.md) | Relationships to user objects. | | +| Name | Type | Description | Notes | +| -------- | -------------------------------------------------------------------- | ------------------------------ | ----- | +| **data** | [**Array<RelationshipToUserData>**](RelationshipToUserData.md) | Relationships to user objects. | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::RelationshipToUsers.new( data: [] ) ``` - diff --git a/docs/v2/ResponseMetaAttributes.md b/docs/v2/ResponseMetaAttributes.md index da81ae85d7bb..a2aea379e00f 100644 --- a/docs/v2/ResponseMetaAttributes.md +++ b/docs/v2/ResponseMetaAttributes.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **page** | [**Pagination**](Pagination.md) | | [optional] | +| Name | Type | Description | Notes | +| -------- | ------------------------------- | ----------- | ---------- | +| **page** | [**Pagination**](Pagination.md) | | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::ResponseMetaAttributes.new( page: null ) ``` - diff --git a/docs/v2/Role.md b/docs/v2/Role.md index a15c206491c2..935cf4ad2d9f 100644 --- a/docs/v2/Role.md +++ b/docs/v2/Role.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**RoleAttributes**](RoleAttributes.md) | | [optional] | -| **id** | **String** | ID of the role. | [optional] | -| **relationships** | [**RoleResponseRelationships**](RoleResponseRelationships.md) | | [optional] | -| **type** | [**RolesType**](RolesType.md) | | [default to 'roles'] | +| Name | Type | Description | Notes | +| ----------------- | ------------------------------------------------------------- | --------------- | ---------------------------- | +| **attributes** | [**RoleAttributes**](RoleAttributes.md) | | [optional] | +| **id** | **String** | ID of the role. | [optional] | +| **relationships** | [**RoleResponseRelationships**](RoleResponseRelationships.md) | | [optional] | +| **type** | [**RolesType**](RolesType.md) | | [default to 'roles'] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V2::Role.new( type: null ) ``` - diff --git a/docs/v2/RoleAttributes.md b/docs/v2/RoleAttributes.md index 3caf5df96542..4ada4ace0fb3 100644 --- a/docs/v2/RoleAttributes.md +++ b/docs/v2/RoleAttributes.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **created_at** | **Time** | Creation time of the role. | [optional][readonly] | -| **modified_at** | **Time** | Time of last role modification. | [optional][readonly] | -| **name** | **String** | Name of the role. | [optional] | -| **user_count** | **Integer** | Number of users with that role. | [optional][readonly] | +| Name | Type | Description | Notes | +| --------------- | ----------- | ------------------------------- | -------------------- | +| **created_at** | **Time** | Creation time of the role. | [optional][readonly] | +| **modified_at** | **Time** | Time of last role modification. | [optional][readonly] | +| **name** | **String** | Name of the role. | [optional] | +| **user_count** | **Integer** | Number of users with that role. | [optional][readonly] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V2::RoleAttributes.new( user_count: null ) ``` - diff --git a/docs/v2/RoleCreateAttributes.md b/docs/v2/RoleCreateAttributes.md index 5b4583045d60..7b80684a1c44 100644 --- a/docs/v2/RoleCreateAttributes.md +++ b/docs/v2/RoleCreateAttributes.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **created_at** | **Time** | Creation time of the role. | [optional][readonly] | -| **modified_at** | **Time** | Time of last role modification. | [optional][readonly] | -| **name** | **String** | Name of the role. | | +| Name | Type | Description | Notes | +| --------------- | ---------- | ------------------------------- | -------------------- | +| **created_at** | **Time** | Creation time of the role. | [optional][readonly] | +| **modified_at** | **Time** | Time of last role modification. | [optional][readonly] | +| **name** | **String** | Name of the role. | | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V2::RoleCreateAttributes.new( name: developers ) ``` - diff --git a/docs/v2/RoleCreateData.md b/docs/v2/RoleCreateData.md index 715e6f9ce680..cf340bd03579 100644 --- a/docs/v2/RoleCreateData.md +++ b/docs/v2/RoleCreateData.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**RoleCreateAttributes**](RoleCreateAttributes.md) | | | -| **relationships** | [**RoleRelationships**](RoleRelationships.md) | | [optional] | -| **type** | [**RolesType**](RolesType.md) | | [optional][default to 'roles'] | +| Name | Type | Description | Notes | +| ----------------- | --------------------------------------------------- | ----------- | -------------------------------------- | +| **attributes** | [**RoleCreateAttributes**](RoleCreateAttributes.md) | | | +| **relationships** | [**RoleRelationships**](RoleRelationships.md) | | [optional] | +| **type** | [**RolesType**](RolesType.md) | | [optional][default to 'roles'] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V2::RoleCreateData.new( type: null ) ``` - diff --git a/docs/v2/RoleCreateRequest.md b/docs/v2/RoleCreateRequest.md index 177ca6c58cd9..7a50962db5e8 100644 --- a/docs/v2/RoleCreateRequest.md +++ b/docs/v2/RoleCreateRequest.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**RoleCreateData**](RoleCreateData.md) | | | +| Name | Type | Description | Notes | +| -------- | --------------------------------------- | ----------- | ----- | +| **data** | [**RoleCreateData**](RoleCreateData.md) | | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::RoleCreateRequest.new( data: null ) ``` - diff --git a/docs/v2/RoleCreateResponse.md b/docs/v2/RoleCreateResponse.md index e5592fc871e9..e147372089b3 100644 --- a/docs/v2/RoleCreateResponse.md +++ b/docs/v2/RoleCreateResponse.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**RoleCreateResponseData**](RoleCreateResponseData.md) | | [optional] | +| Name | Type | Description | Notes | +| -------- | ------------------------------------------------------- | ----------- | ---------- | +| **data** | [**RoleCreateResponseData**](RoleCreateResponseData.md) | | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::RoleCreateResponse.new( data: null ) ``` - diff --git a/docs/v2/RoleCreateResponseData.md b/docs/v2/RoleCreateResponseData.md index 573a18ebbe08..87893ee40264 100644 --- a/docs/v2/RoleCreateResponseData.md +++ b/docs/v2/RoleCreateResponseData.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**RoleCreateAttributes**](RoleCreateAttributes.md) | | [optional] | -| **id** | **String** | ID of the role. | [optional] | -| **relationships** | [**RoleResponseRelationships**](RoleResponseRelationships.md) | | [optional] | -| **type** | [**RolesType**](RolesType.md) | | [default to 'roles'] | +| Name | Type | Description | Notes | +| ----------------- | ------------------------------------------------------------- | --------------- | ---------------------------- | +| **attributes** | [**RoleCreateAttributes**](RoleCreateAttributes.md) | | [optional] | +| **id** | **String** | ID of the role. | [optional] | +| **relationships** | [**RoleResponseRelationships**](RoleResponseRelationships.md) | | [optional] | +| **type** | [**RolesType**](RolesType.md) | | [default to 'roles'] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V2::RoleCreateResponseData.new( type: null ) ``` - diff --git a/docs/v2/RoleRelationships.md b/docs/v2/RoleRelationships.md index 8e29beab8c2f..fad6cc483844 100644 --- a/docs/v2/RoleRelationships.md +++ b/docs/v2/RoleRelationships.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **permissions** | [**RelationshipToPermissions**](RelationshipToPermissions.md) | | [optional] | -| **users** | [**RelationshipToUsers**](RelationshipToUsers.md) | | [optional] | +| Name | Type | Description | Notes | +| --------------- | ------------------------------------------------------------- | ----------- | ---------- | +| **permissions** | [**RelationshipToPermissions**](RelationshipToPermissions.md) | | [optional] | +| **users** | [**RelationshipToUsers**](RelationshipToUsers.md) | | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::RoleRelationships.new( users: null ) ``` - diff --git a/docs/v2/RoleResponse.md b/docs/v2/RoleResponse.md index 63d32cf864f1..8f0b2dd182df 100644 --- a/docs/v2/RoleResponse.md +++ b/docs/v2/RoleResponse.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**Role**](Role.md) | | [optional] | +| Name | Type | Description | Notes | +| -------- | ------------------- | ----------- | ---------- | +| **data** | [**Role**](Role.md) | | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::RoleResponse.new( data: null ) ``` - diff --git a/docs/v2/RoleResponseRelationships.md b/docs/v2/RoleResponseRelationships.md index 2294d12a1bfe..ab416633f49d 100644 --- a/docs/v2/RoleResponseRelationships.md +++ b/docs/v2/RoleResponseRelationships.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **permissions** | [**RelationshipToPermissions**](RelationshipToPermissions.md) | | [optional] | +| Name | Type | Description | Notes | +| --------------- | ------------------------------------------------------------- | ----------- | ---------- | +| **permissions** | [**RelationshipToPermissions**](RelationshipToPermissions.md) | | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::RoleResponseRelationships.new( permissions: null ) ``` - diff --git a/docs/v2/RoleUpdateAttributes.md b/docs/v2/RoleUpdateAttributes.md index 58bb333a6659..90fcf46c0f24 100644 --- a/docs/v2/RoleUpdateAttributes.md +++ b/docs/v2/RoleUpdateAttributes.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **created_at** | **Time** | Creation time of the role. | [optional][readonly] | -| **modified_at** | **Time** | Time of last role modification. | [optional][readonly] | -| **name** | **String** | Name of the role. | [optional] | +| Name | Type | Description | Notes | +| --------------- | ---------- | ------------------------------- | -------------------- | +| **created_at** | **Time** | Creation time of the role. | [optional][readonly] | +| **modified_at** | **Time** | Time of last role modification. | [optional][readonly] | +| **name** | **String** | Name of the role. | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V2::RoleUpdateAttributes.new( name: null ) ``` - diff --git a/docs/v2/RoleUpdateData.md b/docs/v2/RoleUpdateData.md index ae8055a0816b..1c327e2cba96 100644 --- a/docs/v2/RoleUpdateData.md +++ b/docs/v2/RoleUpdateData.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**RoleUpdateAttributes**](RoleUpdateAttributes.md) | | | -| **id** | **String** | ID of the role. | | -| **type** | [**RolesType**](RolesType.md) | | [default to 'roles'] | +| Name | Type | Description | Notes | +| -------------- | --------------------------------------------------- | --------------- | ---------------------------- | +| **attributes** | [**RoleUpdateAttributes**](RoleUpdateAttributes.md) | | | +| **id** | **String** | ID of the role. | | +| **type** | [**RolesType**](RolesType.md) | | [default to 'roles'] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V2::RoleUpdateData.new( type: null ) ``` - diff --git a/docs/v2/RoleUpdateRequest.md b/docs/v2/RoleUpdateRequest.md index 2911f92dd39d..ac3075882cfb 100644 --- a/docs/v2/RoleUpdateRequest.md +++ b/docs/v2/RoleUpdateRequest.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**RoleUpdateData**](RoleUpdateData.md) | | | +| Name | Type | Description | Notes | +| -------- | --------------------------------------- | ----------- | ----- | +| **data** | [**RoleUpdateData**](RoleUpdateData.md) | | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::RoleUpdateRequest.new( data: null ) ``` - diff --git a/docs/v2/RoleUpdateResponse.md b/docs/v2/RoleUpdateResponse.md index 59d1b74ba1cd..4b107117d60d 100644 --- a/docs/v2/RoleUpdateResponse.md +++ b/docs/v2/RoleUpdateResponse.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**RoleUpdateResponseData**](RoleUpdateResponseData.md) | | [optional] | +| Name | Type | Description | Notes | +| -------- | ------------------------------------------------------- | ----------- | ---------- | +| **data** | [**RoleUpdateResponseData**](RoleUpdateResponseData.md) | | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::RoleUpdateResponse.new( data: null ) ``` - diff --git a/docs/v2/RoleUpdateResponseData.md b/docs/v2/RoleUpdateResponseData.md index 28281b044220..38eb677ab6d4 100644 --- a/docs/v2/RoleUpdateResponseData.md +++ b/docs/v2/RoleUpdateResponseData.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**RoleUpdateAttributes**](RoleUpdateAttributes.md) | | [optional] | -| **id** | **String** | ID of the role. | [optional] | -| **relationships** | [**RoleResponseRelationships**](RoleResponseRelationships.md) | | [optional] | -| **type** | [**RolesType**](RolesType.md) | | [default to 'roles'] | +| Name | Type | Description | Notes | +| ----------------- | ------------------------------------------------------------- | --------------- | ---------------------------- | +| **attributes** | [**RoleUpdateAttributes**](RoleUpdateAttributes.md) | | [optional] | +| **id** | **String** | ID of the role. | [optional] | +| **relationships** | [**RoleResponseRelationships**](RoleResponseRelationships.md) | | [optional] | +| **type** | [**RolesType**](RolesType.md) | | [default to 'roles'] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V2::RoleUpdateResponseData.new( type: null ) ``` - diff --git a/docs/v2/RolesAPI.md b/docs/v2/RolesAPI.md index 59a8047c79b7..011416ab149a 100644 --- a/docs/v2/RolesAPI.md +++ b/docs/v2/RolesAPI.md @@ -2,21 +2,20 @@ All URIs are relative to *https://api.datadoghq.com* -| Method | HTTP request | Description | -| ------ | ------------ | ----------- | -| [**add_permission_to_role**](RolesAPI.md#add_permission_to_role) | **POST** /api/v2/roles/{role_id}/permissions | Grant permission to a role | -| [**add_user_to_role**](RolesAPI.md#add_user_to_role) | **POST** /api/v2/roles/{role_id}/users | Add a user to a role | -| [**create_role**](RolesAPI.md#create_role) | **POST** /api/v2/roles | Create role | -| [**delete_role**](RolesAPI.md#delete_role) | **DELETE** /api/v2/roles/{role_id} | Delete role | -| [**get_role**](RolesAPI.md#get_role) | **GET** /api/v2/roles/{role_id} | Get a role | -| [**list_permissions**](RolesAPI.md#list_permissions) | **GET** /api/v2/permissions | List permissions | -| [**list_role_permissions**](RolesAPI.md#list_role_permissions) | **GET** /api/v2/roles/{role_id}/permissions | List permissions for a role | -| [**list_role_users**](RolesAPI.md#list_role_users) | **GET** /api/v2/roles/{role_id}/users | Get all users of a role | -| [**list_roles**](RolesAPI.md#list_roles) | **GET** /api/v2/roles | List roles | -| [**remove_permission_from_role**](RolesAPI.md#remove_permission_from_role) | **DELETE** /api/v2/roles/{role_id}/permissions | Revoke permission | -| [**remove_user_from_role**](RolesAPI.md#remove_user_from_role) | **DELETE** /api/v2/roles/{role_id}/users | Remove a user from a role | -| [**update_role**](RolesAPI.md#update_role) | **PATCH** /api/v2/roles/{role_id} | Update a role | - +| Method | HTTP request | Description | +| -------------------------------------------------------------------------- | ---------------------------------------------- | --------------------------- | +| [**add_permission_to_role**](RolesAPI.md#add_permission_to_role) | **POST** /api/v2/roles/{role_id}/permissions | Grant permission to a role | +| [**add_user_to_role**](RolesAPI.md#add_user_to_role) | **POST** /api/v2/roles/{role_id}/users | Add a user to a role | +| [**create_role**](RolesAPI.md#create_role) | **POST** /api/v2/roles | Create role | +| [**delete_role**](RolesAPI.md#delete_role) | **DELETE** /api/v2/roles/{role_id} | Delete role | +| [**get_role**](RolesAPI.md#get_role) | **GET** /api/v2/roles/{role_id} | Get a role | +| [**list_permissions**](RolesAPI.md#list_permissions) | **GET** /api/v2/permissions | List permissions | +| [**list_role_permissions**](RolesAPI.md#list_role_permissions) | **GET** /api/v2/roles/{role_id}/permissions | List permissions for a role | +| [**list_role_users**](RolesAPI.md#list_role_users) | **GET** /api/v2/roles/{role_id}/users | Get all users of a role | +| [**list_roles**](RolesAPI.md#list_roles) | **GET** /api/v2/roles | List roles | +| [**remove_permission_from_role**](RolesAPI.md#remove_permission_from_role) | **DELETE** /api/v2/roles/{role_id}/permissions | Revoke permission | +| [**remove_user_from_role**](RolesAPI.md#remove_user_from_role) | **DELETE** /api/v2/roles/{role_id}/users | Remove a user from a role | +| [**update_role**](RolesAPI.md#update_role) | **PATCH** /api/v2/roles/{role_id} | Update a role | ## add_permission_to_role @@ -30,7 +29,7 @@ Adds a permission to a role. require 'datadog_api_client' api_instance = DatadogAPIClient::V2::RolesAPI.new role_id = 'role_id_example' # String | The ID of the role. -body = DatadogAPIClient::V2::RelationshipToPermission.new # RelationshipToPermission | +body = DatadogAPIClient::V2::RelationshipToPermission.new # RelationshipToPermission | begin # Grant permission to a role @@ -61,10 +60,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **role_id** | **String** | The ID of the role. | | -| **body** | [**RelationshipToPermission**](RelationshipToPermission.md) | | | +| Name | Type | Description | Notes | +| ----------- | ----------------------------------------------------------- | ------------------- | ----- | +| **role_id** | **String** | The ID of the role. | | +| **body** | [**RelationshipToPermission**](RelationshipToPermission.md) | | | ### Return type @@ -79,7 +78,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## add_user_to_role > add_user_to_role(role_id, body) @@ -92,7 +90,7 @@ Adds a user to a role. require 'datadog_api_client' api_instance = DatadogAPIClient::V2::RolesAPI.new role_id = 'role_id_example' # String | The ID of the role. -body = DatadogAPIClient::V2::RelationshipToUser.new({data: DatadogAPIClient::V2::RelationshipToUserData.new({id: '00000000-0000-0000-0000-000000000000', type: DatadogAPIClient::V2::UsersType::USERS})}) # RelationshipToUser | +body = DatadogAPIClient::V2::RelationshipToUser.new({data: DatadogAPIClient::V2::RelationshipToUserData.new({id: '00000000-0000-0000-0000-000000000000', type: DatadogAPIClient::V2::UsersType::USERS})}) # RelationshipToUser | begin # Add a user to a role @@ -123,10 +121,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **role_id** | **String** | The ID of the role. | | -| **body** | [**RelationshipToUser**](RelationshipToUser.md) | | | +| Name | Type | Description | Notes | +| ----------- | ----------------------------------------------- | ------------------- | ----- | +| **role_id** | **String** | The ID of the role. | | +| **body** | [**RelationshipToUser**](RelationshipToUser.md) | | | ### Return type @@ -141,7 +139,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## create_role > create_role(body) @@ -153,7 +150,7 @@ Create a new role for your organization. ```ruby require 'datadog_api_client' api_instance = DatadogAPIClient::V2::RolesAPI.new -body = DatadogAPIClient::V2::RoleCreateRequest.new({data: DatadogAPIClient::V2::RoleCreateData.new({attributes: DatadogAPIClient::V2::RoleCreateAttributes.new({name: 'developers'})})}) # RoleCreateRequest | +body = DatadogAPIClient::V2::RoleCreateRequest.new({data: DatadogAPIClient::V2::RoleCreateData.new({attributes: DatadogAPIClient::V2::RoleCreateAttributes.new({name: 'developers'})})}) # RoleCreateRequest | begin # Create role @@ -184,9 +181,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**RoleCreateRequest**](RoleCreateRequest.md) | | | +| Name | Type | Description | Notes | +| -------- | --------------------------------------------- | ----------- | ----- | +| **body** | [**RoleCreateRequest**](RoleCreateRequest.md) | | | ### Return type @@ -201,7 +198,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## delete_role > delete_role(role_id) @@ -243,9 +239,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **role_id** | **String** | The ID of the role. | | +| Name | Type | Description | Notes | +| ----------- | ---------- | ------------------- | ----- | +| **role_id** | **String** | The ID of the role. | | ### Return type @@ -260,7 +256,6 @@ nil (empty response body) - **Content-Type**: Not defined - **Accept**: application/json - ## get_role > get_role(role_id) @@ -303,9 +298,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **role_id** | **String** | The ID of the role. | | +| Name | Type | Description | Notes | +| ----------- | ---------- | ------------------- | ----- | +| **role_id** | **String** | The ID of the role. | | ### Return type @@ -320,7 +315,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## list_permissions > list_permissions @@ -377,7 +371,6 @@ This endpoint does not need any parameter. - **Content-Type**: Not defined - **Accept**: application/json - ## list_role_permissions > list_role_permissions(role_id) @@ -420,9 +413,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **role_id** | **String** | The ID of the role. | | +| Name | Type | Description | Notes | +| ----------- | ---------- | ------------------- | ----- | +| **role_id** | **String** | The ID of the role. | | ### Return type @@ -437,7 +430,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## list_role_users > list_role_users(role_id, opts) @@ -486,13 +478,13 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **role_id** | **String** | The ID of the role. | | -| **page_size** | **Integer** | Size for a given page. | [optional][default to 10] | -| **page_number** | **Integer** | Specific page number to return. | [optional][default to 0] | -| **sort** | **String** | User attribute to order results by. Sort order is **ascending** by default. Sort order is **descending** if the field is prefixed by a negative sign, for example `sort=-name`. Options: `name`, `email`, `status`. | [optional][default to 'name'] | -| **filter** | **String** | Filter all users by the given string. Defaults to no filtering. | [optional] | +| Name | Type | Description | Notes | +| --------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | +| **role_id** | **String** | The ID of the role. | | +| **page_size** | **Integer** | Size for a given page. | [optional][default to 10] | +| **page_number** | **Integer** | Specific page number to return. | [optional][default to 0] | +| **sort** | **String** | User attribute to order results by. Sort order is **ascending** by default. Sort order is **descending** if the field is prefixed by a negative sign, for example `sort=-name`. Options: `name`, `email`, `status`. | [optional][default to 'name'] | +| **filter** | **String** | Filter all users by the given string. Defaults to no filtering. | [optional] | ### Return type @@ -507,7 +499,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## list_roles > list_roles(opts) @@ -555,12 +546,12 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **page_size** | **Integer** | Size for a given page. | [optional][default to 10] | -| **page_number** | **Integer** | Specific page number to return. | [optional][default to 0] | -| **sort** | **RolesSort** | Sort roles depending on the given field. Sort order is **ascending** by default. Sort order is **descending** if the field is prefixed by a negative sign, for example: `sort=-name`. | [optional][default to 'name'] | -| **filter** | **String** | Filter all roles by the given string. | [optional] | +| Name | Type | Description | Notes | +| --------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | +| **page_size** | **Integer** | Size for a given page. | [optional][default to 10] | +| **page_number** | **Integer** | Specific page number to return. | [optional][default to 0] | +| **sort** | **RolesSort** | Sort roles depending on the given field. Sort order is **ascending** by default. Sort order is **descending** if the field is prefixed by a negative sign, for example: `sort=-name`. | [optional][default to 'name'] | +| **filter** | **String** | Filter all roles by the given string. | [optional] | ### Return type @@ -575,7 +566,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## remove_permission_from_role > remove_permission_from_role(role_id, body) @@ -588,7 +578,7 @@ Removes a permission from a role. require 'datadog_api_client' api_instance = DatadogAPIClient::V2::RolesAPI.new role_id = 'role_id_example' # String | The ID of the role. -body = DatadogAPIClient::V2::RelationshipToPermission.new # RelationshipToPermission | +body = DatadogAPIClient::V2::RelationshipToPermission.new # RelationshipToPermission | begin # Revoke permission @@ -619,10 +609,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **role_id** | **String** | The ID of the role. | | -| **body** | [**RelationshipToPermission**](RelationshipToPermission.md) | | | +| Name | Type | Description | Notes | +| ----------- | ----------------------------------------------------------- | ------------------- | ----- | +| **role_id** | **String** | The ID of the role. | | +| **body** | [**RelationshipToPermission**](RelationshipToPermission.md) | | | ### Return type @@ -637,7 +627,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## remove_user_from_role > remove_user_from_role(role_id, body) @@ -650,7 +639,7 @@ Removes a user from a role. require 'datadog_api_client' api_instance = DatadogAPIClient::V2::RolesAPI.new role_id = 'role_id_example' # String | The ID of the role. -body = DatadogAPIClient::V2::RelationshipToUser.new({data: DatadogAPIClient::V2::RelationshipToUserData.new({id: '00000000-0000-0000-0000-000000000000', type: DatadogAPIClient::V2::UsersType::USERS})}) # RelationshipToUser | +body = DatadogAPIClient::V2::RelationshipToUser.new({data: DatadogAPIClient::V2::RelationshipToUserData.new({id: '00000000-0000-0000-0000-000000000000', type: DatadogAPIClient::V2::UsersType::USERS})}) # RelationshipToUser | begin # Remove a user from a role @@ -681,10 +670,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **role_id** | **String** | The ID of the role. | | -| **body** | [**RelationshipToUser**](RelationshipToUser.md) | | | +| Name | Type | Description | Notes | +| ----------- | ----------------------------------------------- | ------------------- | ----- | +| **role_id** | **String** | The ID of the role. | | +| **body** | [**RelationshipToUser**](RelationshipToUser.md) | | | ### Return type @@ -699,7 +688,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## update_role > update_role(role_id, body) @@ -712,7 +700,7 @@ Edit a role. Can only be used with application keys belonging to administrators. require 'datadog_api_client' api_instance = DatadogAPIClient::V2::RolesAPI.new role_id = 'role_id_example' # String | The ID of the role. -body = DatadogAPIClient::V2::RoleUpdateRequest.new({data: DatadogAPIClient::V2::RoleUpdateData.new({attributes: DatadogAPIClient::V2::RoleUpdateAttributes.new, id: '00000000-0000-0000-0000-000000000000', type: DatadogAPIClient::V2::RolesType::ROLES})}) # RoleUpdateRequest | +body = DatadogAPIClient::V2::RoleUpdateRequest.new({data: DatadogAPIClient::V2::RoleUpdateData.new({attributes: DatadogAPIClient::V2::RoleUpdateAttributes.new, id: '00000000-0000-0000-0000-000000000000', type: DatadogAPIClient::V2::RolesType::ROLES})}) # RoleUpdateRequest | begin # Update a role @@ -743,10 +731,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **role_id** | **String** | The ID of the role. | | -| **body** | [**RoleUpdateRequest**](RoleUpdateRequest.md) | | | +| Name | Type | Description | Notes | +| ----------- | --------------------------------------------- | ------------------- | ----- | +| **role_id** | **String** | The ID of the role. | | +| **body** | [**RoleUpdateRequest**](RoleUpdateRequest.md) | | | ### Return type @@ -760,4 +748,3 @@ end - **Content-Type**: application/json - **Accept**: application/json - diff --git a/docs/v2/RolesResponse.md b/docs/v2/RolesResponse.md index 3f7c1b2a5e5c..44a93d683d47 100644 --- a/docs/v2/RolesResponse.md +++ b/docs/v2/RolesResponse.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**Array<Role>**](Role.md) | Array of returned roles. | [optional] | -| **meta** | [**ResponseMetaAttributes**](ResponseMetaAttributes.md) | | [optional] | +| Name | Type | Description | Notes | +| -------- | ------------------------------------------------------- | ------------------------ | ---------- | +| **data** | [**Array<Role>**](Role.md) | Array of returned roles. | [optional] | +| **meta** | [**ResponseMetaAttributes**](ResponseMetaAttributes.md) | | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::RolesResponse.new( meta: null ) ``` - diff --git a/docs/v2/RolesSort.md b/docs/v2/RolesSort.md index 8f40898af6d5..a1d7282f0985 100644 --- a/docs/v2/RolesSort.md +++ b/docs/v2/RolesSort.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::RolesSort.new() ``` - diff --git a/docs/v2/RolesType.md b/docs/v2/RolesType.md index 522ea4af6737..d02563d74024 100644 --- a/docs/v2/RolesType.md +++ b/docs/v2/RolesType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::RolesType.new() ``` - diff --git a/docs/v2/SecurityFilter.md b/docs/v2/SecurityFilter.md index 20f3ba3d3552..4f3bc2639997 100644 --- a/docs/v2/SecurityFilter.md +++ b/docs/v2/SecurityFilter.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**SecurityFilterAttributes**](SecurityFilterAttributes.md) | | [optional] | -| **id** | **String** | The ID of the security filter. | [optional] | -| **type** | [**SecurityFilterType**](SecurityFilterType.md) | | [optional][default to 'security_filters'] | +| Name | Type | Description | Notes | +| -------------- | ----------------------------------------------------------- | ------------------------------ | ------------------------------------------------- | +| **attributes** | [**SecurityFilterAttributes**](SecurityFilterAttributes.md) | | [optional] | +| **id** | **String** | The ID of the security filter. | [optional] | +| **type** | [**SecurityFilterType**](SecurityFilterType.md) | | [optional][default to 'security_filters'] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V2::SecurityFilter.new( type: null ) ``` - diff --git a/docs/v2/SecurityFilterAttributes.md b/docs/v2/SecurityFilterAttributes.md index a7ec171d7424..f04e44070233 100644 --- a/docs/v2/SecurityFilterAttributes.md +++ b/docs/v2/SecurityFilterAttributes.md @@ -2,15 +2,15 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **exclusion_filters** | [**Array<SecurityFilterExclusionFilterResponse>**](SecurityFilterExclusionFilterResponse.md) | The list of exclusion filters applied in this security filter. | [optional] | -| **filtered_data_type** | [**SecurityFilterFilteredDataType**](SecurityFilterFilteredDataType.md) | | [optional] | -| **is_builtin** | **Boolean** | Whether the security filter is the built-in filter. | [optional] | -| **is_enabled** | **Boolean** | Whether the security filter is enabled. | [optional] | -| **name** | **String** | The security filter name. | [optional] | -| **query** | **String** | The security filter query. Logs accepted by this query will be accepted by this filter. | [optional] | -| **version** | **Integer** | The version of the security filter. | [optional] | +| Name | Type | Description | Notes | +| ---------------------- | -------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | ---------- | +| **exclusion_filters** | [**Array<SecurityFilterExclusionFilterResponse>**](SecurityFilterExclusionFilterResponse.md) | The list of exclusion filters applied in this security filter. | [optional] | +| **filtered_data_type** | [**SecurityFilterFilteredDataType**](SecurityFilterFilteredDataType.md) | | [optional] | +| **is_builtin** | **Boolean** | Whether the security filter is the built-in filter. | [optional] | +| **is_enabled** | **Boolean** | Whether the security filter is enabled. | [optional] | +| **name** | **String** | The security filter name. | [optional] | +| **query** | **String** | The security filter query. Logs accepted by this query will be accepted by this filter. | [optional] | +| **version** | **Integer** | The version of the security filter. | [optional] | ## Example @@ -27,4 +27,3 @@ instance = DatadogAPIClient::V2::SecurityFilterAttributes.new( version: 1 ) ``` - diff --git a/docs/v2/SecurityFilterCreateAttributes.md b/docs/v2/SecurityFilterCreateAttributes.md index 705ccc8e86f5..8657faf87e48 100644 --- a/docs/v2/SecurityFilterCreateAttributes.md +++ b/docs/v2/SecurityFilterCreateAttributes.md @@ -2,13 +2,13 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **exclusion_filters** | [**Array<SecurityFilterExclusionFilter>**](SecurityFilterExclusionFilter.md) | Exclusion filters to exclude some logs from the security filter. | | -| **filtered_data_type** | [**SecurityFilterFilteredDataType**](SecurityFilterFilteredDataType.md) | | | -| **is_enabled** | **Boolean** | Whether the security filter is enabled. | | -| **name** | **String** | The name of the security filter. | | -| **query** | **String** | The query of the security filter. | | +| Name | Type | Description | Notes | +| ---------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------- | ----- | +| **exclusion_filters** | [**Array<SecurityFilterExclusionFilter>**](SecurityFilterExclusionFilter.md) | Exclusion filters to exclude some logs from the security filter. | | +| **filtered_data_type** | [**SecurityFilterFilteredDataType**](SecurityFilterFilteredDataType.md) | | | +| **is_enabled** | **Boolean** | Whether the security filter is enabled. | | +| **name** | **String** | The name of the security filter. | | +| **query** | **String** | The query of the security filter. | | ## Example @@ -23,4 +23,3 @@ instance = DatadogAPIClient::V2::SecurityFilterCreateAttributes.new( query: service:api ) ``` - diff --git a/docs/v2/SecurityFilterCreateData.md b/docs/v2/SecurityFilterCreateData.md index 9d00cc8f9590..737cac057818 100644 --- a/docs/v2/SecurityFilterCreateData.md +++ b/docs/v2/SecurityFilterCreateData.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**SecurityFilterCreateAttributes**](SecurityFilterCreateAttributes.md) | | | -| **type** | [**SecurityFilterType**](SecurityFilterType.md) | | [default to 'security_filters'] | +| Name | Type | Description | Notes | +| -------------- | ----------------------------------------------------------------------- | ----------- | --------------------------------------- | +| **attributes** | [**SecurityFilterCreateAttributes**](SecurityFilterCreateAttributes.md) | | | +| **type** | [**SecurityFilterType**](SecurityFilterType.md) | | [default to 'security_filters'] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::SecurityFilterCreateData.new( type: null ) ``` - diff --git a/docs/v2/SecurityFilterCreateRequest.md b/docs/v2/SecurityFilterCreateRequest.md index 492ae7630029..63ffdfe35cc6 100644 --- a/docs/v2/SecurityFilterCreateRequest.md +++ b/docs/v2/SecurityFilterCreateRequest.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**SecurityFilterCreateData**](SecurityFilterCreateData.md) | | | +| Name | Type | Description | Notes | +| -------- | ----------------------------------------------------------- | ----------- | ----- | +| **data** | [**SecurityFilterCreateData**](SecurityFilterCreateData.md) | | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::SecurityFilterCreateRequest.new( data: null ) ``` - diff --git a/docs/v2/SecurityFilterExclusionFilter.md b/docs/v2/SecurityFilterExclusionFilter.md index 03843ede937e..0d56bd775109 100644 --- a/docs/v2/SecurityFilterExclusionFilter.md +++ b/docs/v2/SecurityFilterExclusionFilter.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **name** | **String** | Exclusion filter name. | | -| **query** | **String** | Exclusion filter query. Logs that match this query are excluded from the security filter. | | +| Name | Type | Description | Notes | +| --------- | ---------- | ----------------------------------------------------------------------------------------- | ----- | +| **name** | **String** | Exclusion filter name. | | +| **query** | **String** | Exclusion filter query. Logs that match this query are excluded from the security filter. | | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::SecurityFilterExclusionFilter.new( query: source:staging ) ``` - diff --git a/docs/v2/SecurityFilterExclusionFilterResponse.md b/docs/v2/SecurityFilterExclusionFilterResponse.md index 65fd2be5c997..c37fb6680a32 100644 --- a/docs/v2/SecurityFilterExclusionFilterResponse.md +++ b/docs/v2/SecurityFilterExclusionFilterResponse.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **name** | **String** | The exclusion filter name. | [optional] | +| Name | Type | Description | Notes | +| --------- | ---------- | --------------------------- | ---------- | +| **name** | **String** | The exclusion filter name. | [optional] | | **query** | **String** | The exclusion filter query. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::SecurityFilterExclusionFilterResponse.new( query: source:staging ) ``` - diff --git a/docs/v2/SecurityFilterFilteredDataType.md b/docs/v2/SecurityFilterFilteredDataType.md index 0d8c60b00120..75b0e6d26b9d 100644 --- a/docs/v2/SecurityFilterFilteredDataType.md +++ b/docs/v2/SecurityFilterFilteredDataType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::SecurityFilterFilteredDataType.new() ``` - diff --git a/docs/v2/SecurityFilterMeta.md b/docs/v2/SecurityFilterMeta.md index ae2dd084cd8f..6dd2e473b122 100644 --- a/docs/v2/SecurityFilterMeta.md +++ b/docs/v2/SecurityFilterMeta.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| ----------- | ---------- | ------------------ | ---------- | | **warning** | **String** | A warning message. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::SecurityFilterMeta.new( warning: All the security filters are disabled. As a result, no logs are being analyzed. ) ``` - diff --git a/docs/v2/SecurityFilterResponse.md b/docs/v2/SecurityFilterResponse.md index 5570fd55538d..1da010e86a26 100644 --- a/docs/v2/SecurityFilterResponse.md +++ b/docs/v2/SecurityFilterResponse.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**SecurityFilter**](SecurityFilter.md) | | [optional] | -| **meta** | [**SecurityFilterMeta**](SecurityFilterMeta.md) | | [optional] | +| Name | Type | Description | Notes | +| -------- | ----------------------------------------------- | ----------- | ---------- | +| **data** | [**SecurityFilter**](SecurityFilter.md) | | [optional] | +| **meta** | [**SecurityFilterMeta**](SecurityFilterMeta.md) | | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::SecurityFilterResponse.new( meta: null ) ``` - diff --git a/docs/v2/SecurityFilterType.md b/docs/v2/SecurityFilterType.md index 1166b0310191..ff7d9680ec91 100644 --- a/docs/v2/SecurityFilterType.md +++ b/docs/v2/SecurityFilterType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::SecurityFilterType.new() ``` - diff --git a/docs/v2/SecurityFilterUpdateAttributes.md b/docs/v2/SecurityFilterUpdateAttributes.md index e075f3e591d1..4a5640a01483 100644 --- a/docs/v2/SecurityFilterUpdateAttributes.md +++ b/docs/v2/SecurityFilterUpdateAttributes.md @@ -2,14 +2,14 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **exclusion_filters** | [**Array<SecurityFilterExclusionFilter>**](SecurityFilterExclusionFilter.md) | Exclusion filters to exclude some logs from the security filter. | [optional] | -| **filtered_data_type** | [**SecurityFilterFilteredDataType**](SecurityFilterFilteredDataType.md) | | [optional] | -| **is_enabled** | **Boolean** | Whether the security filter is enabled. | [optional] | -| **name** | **String** | The name of the security filter. | [optional] | -| **query** | **String** | The query of the security filter. | [optional] | -| **version** | **Integer** | The version of the security filter to update. | [optional] | +| Name | Type | Description | Notes | +| ---------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------- | ---------- | +| **exclusion_filters** | [**Array<SecurityFilterExclusionFilter>**](SecurityFilterExclusionFilter.md) | Exclusion filters to exclude some logs from the security filter. | [optional] | +| **filtered_data_type** | [**SecurityFilterFilteredDataType**](SecurityFilterFilteredDataType.md) | | [optional] | +| **is_enabled** | **Boolean** | Whether the security filter is enabled. | [optional] | +| **name** | **String** | The name of the security filter. | [optional] | +| **query** | **String** | The query of the security filter. | [optional] | +| **version** | **Integer** | The version of the security filter to update. | [optional] | ## Example @@ -25,4 +25,3 @@ instance = DatadogAPIClient::V2::SecurityFilterUpdateAttributes.new( version: 1 ) ``` - diff --git a/docs/v2/SecurityFilterUpdateData.md b/docs/v2/SecurityFilterUpdateData.md index bc850675d602..4f69ae903d32 100644 --- a/docs/v2/SecurityFilterUpdateData.md +++ b/docs/v2/SecurityFilterUpdateData.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**SecurityFilterUpdateAttributes**](SecurityFilterUpdateAttributes.md) | | | -| **type** | [**SecurityFilterType**](SecurityFilterType.md) | | [default to 'security_filters'] | +| Name | Type | Description | Notes | +| -------------- | ----------------------------------------------------------------------- | ----------- | --------------------------------------- | +| **attributes** | [**SecurityFilterUpdateAttributes**](SecurityFilterUpdateAttributes.md) | | | +| **type** | [**SecurityFilterType**](SecurityFilterType.md) | | [default to 'security_filters'] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::SecurityFilterUpdateData.new( type: null ) ``` - diff --git a/docs/v2/SecurityFilterUpdateRequest.md b/docs/v2/SecurityFilterUpdateRequest.md index fb1027362a7c..1cf720cbce86 100644 --- a/docs/v2/SecurityFilterUpdateRequest.md +++ b/docs/v2/SecurityFilterUpdateRequest.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**SecurityFilterUpdateData**](SecurityFilterUpdateData.md) | | | +| Name | Type | Description | Notes | +| -------- | ----------------------------------------------------------- | ----------- | ----- | +| **data** | [**SecurityFilterUpdateData**](SecurityFilterUpdateData.md) | | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::SecurityFilterUpdateRequest.new( data: null ) ``` - diff --git a/docs/v2/SecurityFiltersResponse.md b/docs/v2/SecurityFiltersResponse.md index 9b53a80ab6cc..a4028e2a6049 100644 --- a/docs/v2/SecurityFiltersResponse.md +++ b/docs/v2/SecurityFiltersResponse.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| -------- | ---------------------------------------------------- | ----------------------------------- | ---------- | | **data** | [**Array<SecurityFilter>**](SecurityFilter.md) | A list of security filters objects. | [optional] | -| **meta** | [**SecurityFilterMeta**](SecurityFilterMeta.md) | | [optional] | +| **meta** | [**SecurityFilterMeta**](SecurityFilterMeta.md) | | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::SecurityFiltersResponse.new( meta: null ) ``` - diff --git a/docs/v2/SecurityMonitoringAPI.md b/docs/v2/SecurityMonitoringAPI.md index 09b6f7483758..1df42d791b0b 100644 --- a/docs/v2/SecurityMonitoringAPI.md +++ b/docs/v2/SecurityMonitoringAPI.md @@ -2,21 +2,20 @@ All URIs are relative to *https://api.datadoghq.com* -| Method | HTTP request | Description | -| ------ | ------------ | ----------- | -| [**create_security_filter**](SecurityMonitoringAPI.md#create_security_filter) | **POST** /api/v2/security_monitoring/configuration/security_filters | Create a security filter | -| [**create_security_monitoring_rule**](SecurityMonitoringAPI.md#create_security_monitoring_rule) | **POST** /api/v2/security_monitoring/rules | Create a detection rule | -| [**delete_security_filter**](SecurityMonitoringAPI.md#delete_security_filter) | **DELETE** /api/v2/security_monitoring/configuration/security_filters/{security_filter_id} | Delete a security filter | -| [**delete_security_monitoring_rule**](SecurityMonitoringAPI.md#delete_security_monitoring_rule) | **DELETE** /api/v2/security_monitoring/rules/{rule_id} | Delete an existing rule | -| [**get_security_filter**](SecurityMonitoringAPI.md#get_security_filter) | **GET** /api/v2/security_monitoring/configuration/security_filters/{security_filter_id} | Get a security filter | -| [**get_security_monitoring_rule**](SecurityMonitoringAPI.md#get_security_monitoring_rule) | **GET** /api/v2/security_monitoring/rules/{rule_id} | Get a rule's details | -| [**list_security_filters**](SecurityMonitoringAPI.md#list_security_filters) | **GET** /api/v2/security_monitoring/configuration/security_filters | Get all security filters | -| [**list_security_monitoring_rules**](SecurityMonitoringAPI.md#list_security_monitoring_rules) | **GET** /api/v2/security_monitoring/rules | List rules | -| [**list_security_monitoring_signals**](SecurityMonitoringAPI.md#list_security_monitoring_signals) | **GET** /api/v2/security_monitoring/signals | Get a quick list of security signals | -| [**search_security_monitoring_signals**](SecurityMonitoringAPI.md#search_security_monitoring_signals) | **POST** /api/v2/security_monitoring/signals/search | Get a list of security signals | -| [**update_security_filter**](SecurityMonitoringAPI.md#update_security_filter) | **PATCH** /api/v2/security_monitoring/configuration/security_filters/{security_filter_id} | Update a security filter | -| [**update_security_monitoring_rule**](SecurityMonitoringAPI.md#update_security_monitoring_rule) | **PUT** /api/v2/security_monitoring/rules/{rule_id} | Update an existing rule | - +| Method | HTTP request | Description | +| ----------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | ------------------------------------ | +| [**create_security_filter**](SecurityMonitoringAPI.md#create_security_filter) | **POST** /api/v2/security_monitoring/configuration/security_filters | Create a security filter | +| [**create_security_monitoring_rule**](SecurityMonitoringAPI.md#create_security_monitoring_rule) | **POST** /api/v2/security_monitoring/rules | Create a detection rule | +| [**delete_security_filter**](SecurityMonitoringAPI.md#delete_security_filter) | **DELETE** /api/v2/security_monitoring/configuration/security_filters/{security_filter_id} | Delete a security filter | +| [**delete_security_monitoring_rule**](SecurityMonitoringAPI.md#delete_security_monitoring_rule) | **DELETE** /api/v2/security_monitoring/rules/{rule_id} | Delete an existing rule | +| [**get_security_filter**](SecurityMonitoringAPI.md#get_security_filter) | **GET** /api/v2/security_monitoring/configuration/security_filters/{security_filter_id} | Get a security filter | +| [**get_security_monitoring_rule**](SecurityMonitoringAPI.md#get_security_monitoring_rule) | **GET** /api/v2/security_monitoring/rules/{rule_id} | Get a rule's details | +| [**list_security_filters**](SecurityMonitoringAPI.md#list_security_filters) | **GET** /api/v2/security_monitoring/configuration/security_filters | Get all security filters | +| [**list_security_monitoring_rules**](SecurityMonitoringAPI.md#list_security_monitoring_rules) | **GET** /api/v2/security_monitoring/rules | List rules | +| [**list_security_monitoring_signals**](SecurityMonitoringAPI.md#list_security_monitoring_signals) | **GET** /api/v2/security_monitoring/signals | Get a quick list of security signals | +| [**search_security_monitoring_signals**](SecurityMonitoringAPI.md#search_security_monitoring_signals) | **POST** /api/v2/security_monitoring/signals/search | Get a list of security signals | +| [**update_security_filter**](SecurityMonitoringAPI.md#update_security_filter) | **PATCH** /api/v2/security_monitoring/configuration/security_filters/{security_filter_id} | Update a security filter | +| [**update_security_monitoring_rule**](SecurityMonitoringAPI.md#update_security_monitoring_rule) | **PUT** /api/v2/security_monitoring/rules/{rule_id} | Update an existing rule | ## create_security_filter @@ -63,9 +62,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**SecurityFilterCreateRequest**](SecurityFilterCreateRequest.md) | The definition of the new security filter. | | +| Name | Type | Description | Notes | +| -------- | ----------------------------------------------------------------- | ------------------------------------------ | ----- | +| **body** | [**SecurityFilterCreateRequest**](SecurityFilterCreateRequest.md) | The definition of the new security filter. | | ### Return type @@ -80,7 +79,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## create_security_monitoring_rule > create_security_monitoring_rule(body) @@ -92,7 +90,7 @@ Create a detection rule. ```ruby require 'datadog_api_client' api_instance = DatadogAPIClient::V2::SecurityMonitoringAPI.new -body = DatadogAPIClient::V2::SecurityMonitoringRuleCreatePayload.new({cases: [DatadogAPIClient::V2::SecurityMonitoringRuleCaseCreate.new({status: DatadogAPIClient::V2::SecurityMonitoringRuleSeverity::INFO})], is_enabled: true, message: 'message_example', name: 'My security monitoring rule.', options: DatadogAPIClient::V2::SecurityMonitoringRuleOptions.new, queries: [DatadogAPIClient::V2::SecurityMonitoringRuleQueryCreate.new({query: 'a > 3'})]}) # SecurityMonitoringRuleCreatePayload | +body = DatadogAPIClient::V2::SecurityMonitoringRuleCreatePayload.new({cases: [DatadogAPIClient::V2::SecurityMonitoringRuleCaseCreate.new({status: DatadogAPIClient::V2::SecurityMonitoringRuleSeverity::INFO})], is_enabled: true, message: 'message_example', name: 'My security monitoring rule.', options: DatadogAPIClient::V2::SecurityMonitoringRuleOptions.new, queries: [DatadogAPIClient::V2::SecurityMonitoringRuleQueryCreate.new({query: 'a > 3'})]}) # SecurityMonitoringRuleCreatePayload | begin # Create a detection rule @@ -123,9 +121,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**SecurityMonitoringRuleCreatePayload**](SecurityMonitoringRuleCreatePayload.md) | | | +| Name | Type | Description | Notes | +| -------- | --------------------------------------------------------------------------------- | ----------- | ----- | +| **body** | [**SecurityMonitoringRuleCreatePayload**](SecurityMonitoringRuleCreatePayload.md) | | | ### Return type @@ -140,7 +138,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## delete_security_filter > delete_security_filter(security_filter_id) @@ -182,9 +179,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **security_filter_id** | **String** | The ID of the security filter. | | +| Name | Type | Description | Notes | +| ---------------------- | ---------- | ------------------------------ | ----- | +| **security_filter_id** | **String** | The ID of the security filter. | | ### Return type @@ -199,7 +196,6 @@ nil (empty response body) - **Content-Type**: Not defined - **Accept**: application/json - ## delete_security_monitoring_rule > delete_security_monitoring_rule(rule_id) @@ -241,9 +237,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **rule_id** | **String** | The ID of the rule. | | +| Name | Type | Description | Notes | +| ----------- | ---------- | ------------------- | ----- | +| **rule_id** | **String** | The ID of the rule. | | ### Return type @@ -258,7 +254,6 @@ nil (empty response body) - **Content-Type**: Not defined - **Accept**: application/json - ## get_security_filter > get_security_filter(security_filter_id) @@ -304,9 +299,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **security_filter_id** | **String** | The ID of the security filter. | | +| Name | Type | Description | Notes | +| ---------------------- | ---------- | ------------------------------ | ----- | +| **security_filter_id** | **String** | The ID of the security filter. | | ### Return type @@ -321,7 +316,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## get_security_monitoring_rule > get_security_monitoring_rule(rule_id) @@ -364,9 +358,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **rule_id** | **String** | The ID of the rule. | | +| Name | Type | Description | Notes | +| ----------- | ---------- | ------------------- | ----- | +| **rule_id** | **String** | The ID of the rule. | | ### Return type @@ -381,7 +375,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## list_security_filters > list_security_filters @@ -438,7 +431,6 @@ This endpoint does not need any parameter. - **Content-Type**: Not defined - **Accept**: application/json - ## list_security_monitoring_rules > list_security_monitoring_rules(opts) @@ -484,10 +476,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **page_size** | **Integer** | Size for a given page. | [optional][default to 10] | -| **page_number** | **Integer** | Specific page number to return. | [optional][default to 0] | +| Name | Type | Description | Notes | +| --------------- | ----------- | ------------------------------- | ------------------------- | +| **page_size** | **Integer** | Size for a given page. | [optional][default to 10] | +| **page_number** | **Integer** | Specific page number to return. | [optional][default to 0] | ### Return type @@ -502,7 +494,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## list_security_monitoring_signals > list_security_monitoring_signals(opts) @@ -559,14 +550,14 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **filter_query** | **String** | The search query for security signals. | [optional] | -| **filter_from** | **Time** | The minimum timestamp for requested security signals. | [optional] | -| **filter_to** | **Time** | The maximum timestamp for requested security signals. | [optional] | -| **sort** | **SecurityMonitoringSignalsSort** | The order of the security signals in results. | [optional] | -| **page_cursor** | **String** | A list of results using the cursor provided in the previous query. | [optional] | -| **page_limit** | **Integer** | The maximum number of security signals in the response. | [optional][default to 10] | +| Name | Type | Description | Notes | +| ---------------- | --------------------------------- | ------------------------------------------------------------------ | ------------------------- | +| **filter_query** | **String** | The search query for security signals. | [optional] | +| **filter_from** | **Time** | The minimum timestamp for requested security signals. | [optional] | +| **filter_to** | **Time** | The maximum timestamp for requested security signals. | [optional] | +| **sort** | **SecurityMonitoringSignalsSort** | The order of the security signals in results. | [optional] | +| **page_cursor** | **String** | A list of results using the cursor provided in the previous query. | [optional] | +| **page_limit** | **Integer** | The maximum number of security signals in the response. | [optional][default to 10] | ### Return type @@ -581,7 +572,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## search_security_monitoring_signals > search_security_monitoring_signals(opts) @@ -601,7 +591,7 @@ end api_instance = DatadogAPIClient::V2::SecurityMonitoringAPI.new opts = { - body: DatadogAPIClient::V2::SecurityMonitoringSignalListRequest.new # SecurityMonitoringSignalListRequest | + body: DatadogAPIClient::V2::SecurityMonitoringSignalListRequest.new # SecurityMonitoringSignalListRequest | } begin @@ -633,9 +623,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**SecurityMonitoringSignalListRequest**](SecurityMonitoringSignalListRequest.md) | | [optional] | +| Name | Type | Description | Notes | +| -------- | --------------------------------------------------------------------------------- | ----------- | ---------- | +| **body** | [**SecurityMonitoringSignalListRequest**](SecurityMonitoringSignalListRequest.md) | | [optional] | ### Return type @@ -650,7 +640,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## update_security_filter > update_security_filter(security_filter_id, body) @@ -695,10 +684,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **security_filter_id** | **String** | The ID of the security filter. | | -| **body** | [**SecurityFilterUpdateRequest**](SecurityFilterUpdateRequest.md) | New definition of the security filter. | | +| Name | Type | Description | Notes | +| ---------------------- | ----------------------------------------------------------------- | -------------------------------------- | ----- | +| **security_filter_id** | **String** | The ID of the security filter. | | +| **body** | [**SecurityFilterUpdateRequest**](SecurityFilterUpdateRequest.md) | New definition of the security filter. | | ### Return type @@ -713,7 +702,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## update_security_monitoring_rule > update_security_monitoring_rule(rule_id, body) @@ -728,7 +716,7 @@ Default rules can only be updated to be enabled and to change notifications. require 'datadog_api_client' api_instance = DatadogAPIClient::V2::SecurityMonitoringAPI.new rule_id = 'rule_id_example' # String | The ID of the rule. -body = DatadogAPIClient::V2::SecurityMonitoringRuleUpdatePayload.new # SecurityMonitoringRuleUpdatePayload | +body = DatadogAPIClient::V2::SecurityMonitoringRuleUpdatePayload.new # SecurityMonitoringRuleUpdatePayload | begin # Update an existing rule @@ -759,10 +747,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **rule_id** | **String** | The ID of the rule. | | -| **body** | [**SecurityMonitoringRuleUpdatePayload**](SecurityMonitoringRuleUpdatePayload.md) | | | +| Name | Type | Description | Notes | +| ----------- | --------------------------------------------------------------------------------- | ------------------- | ----- | +| **rule_id** | **String** | The ID of the rule. | | +| **body** | [**SecurityMonitoringRuleUpdatePayload**](SecurityMonitoringRuleUpdatePayload.md) | | | ### Return type @@ -776,4 +764,3 @@ end - **Content-Type**: application/json - **Accept**: application/json - diff --git a/docs/v2/SecurityMonitoringFilter.md b/docs/v2/SecurityMonitoringFilter.md index 013c95a0f84a..6f9649600fb0 100644 --- a/docs/v2/SecurityMonitoringFilter.md +++ b/docs/v2/SecurityMonitoringFilter.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **action** | [**SecurityMonitoringFilterAction**](SecurityMonitoringFilterAction.md) | | [optional] | -| **query** | **String** | Query for selecting logs to apply the filtering action. | [optional] | +| Name | Type | Description | Notes | +| ---------- | ----------------------------------------------------------------------- | ------------------------------------------------------- | ---------- | +| **action** | [**SecurityMonitoringFilterAction**](SecurityMonitoringFilterAction.md) | | [optional] | +| **query** | **String** | Query for selecting logs to apply the filtering action. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::SecurityMonitoringFilter.new( query: null ) ``` - diff --git a/docs/v2/SecurityMonitoringFilterAction.md b/docs/v2/SecurityMonitoringFilterAction.md index 23d0a7e9baa0..94c3dcee8b77 100644 --- a/docs/v2/SecurityMonitoringFilterAction.md +++ b/docs/v2/SecurityMonitoringFilterAction.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::SecurityMonitoringFilterAction.new() ``` - diff --git a/docs/v2/SecurityMonitoringListRulesResponse.md b/docs/v2/SecurityMonitoringListRulesResponse.md index a7968ad1811d..8ff17dd127c8 100644 --- a/docs/v2/SecurityMonitoringListRulesResponse.md +++ b/docs/v2/SecurityMonitoringListRulesResponse.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| -------- | ------------------------------------------------------------------------------------ | ----------------------------------- | ---------- | | **data** | [**Array<SecurityMonitoringRuleResponse>**](SecurityMonitoringRuleResponse.md) | Array containing the list of rules. | [optional] | -| **meta** | [**ResponseMetaAttributes**](ResponseMetaAttributes.md) | | [optional] | +| **meta** | [**ResponseMetaAttributes**](ResponseMetaAttributes.md) | | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::SecurityMonitoringListRulesResponse.new( meta: null ) ``` - diff --git a/docs/v2/SecurityMonitoringRuleCase.md b/docs/v2/SecurityMonitoringRuleCase.md index 6550428d6b2c..c48b86f371c4 100644 --- a/docs/v2/SecurityMonitoringRuleCase.md +++ b/docs/v2/SecurityMonitoringRuleCase.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **condition** | **String** | A rule case contains logical operations (`>`,`>=`, `&&`, `||`) to determine if a signal should be generated based on the event counts in the previously defined queries. | [optional] | -| **name** | **String** | Name of the case. | [optional] | -| **notifications** | **Array<String>** | Notification targets for each rule case. | [optional] | -| **status** | [**SecurityMonitoringRuleSeverity**](SecurityMonitoringRuleSeverity.md) | | [optional] | +| Name | Type | Description | Notes | +| ----------------- | ----------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------- | ---------- | +| **condition** | **String** | A rule case contains logical operations (`>`,`>=`, `&&`, ` | | `) to determine if a signal should be generated based on the event counts in the previously defined queries. | [optional] | +| **name** | **String** | Name of the case. | [optional] | +| **notifications** | **Array<String>** | Notification targets for each rule case. | [optional] | +| **status** | [**SecurityMonitoringRuleSeverity**](SecurityMonitoringRuleSeverity.md) | | [optional] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V2::SecurityMonitoringRuleCase.new( status: null ) ``` - diff --git a/docs/v2/SecurityMonitoringRuleCaseCreate.md b/docs/v2/SecurityMonitoringRuleCaseCreate.md index 8e580e6fd70f..8ddee08e48eb 100644 --- a/docs/v2/SecurityMonitoringRuleCaseCreate.md +++ b/docs/v2/SecurityMonitoringRuleCaseCreate.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **condition** | **String** | A rule case contains logical operations (`>`,`>=`, `&&`, `||`) to determine if a signal should be generated based on the event counts in the previously defined queries. | [optional] | -| **name** | **String** | Name of the case. | [optional] | -| **notifications** | **Array<String>** | Notification targets for each rule case. | [optional] | -| **status** | [**SecurityMonitoringRuleSeverity**](SecurityMonitoringRuleSeverity.md) | | | +| Name | Type | Description | Notes | +| ----------------- | ----------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------- | ---------- | +| **condition** | **String** | A rule case contains logical operations (`>`,`>=`, `&&`, ` | | `) to determine if a signal should be generated based on the event counts in the previously defined queries. | [optional] | +| **name** | **String** | Name of the case. | [optional] | +| **notifications** | **Array<String>** | Notification targets for each rule case. | [optional] | +| **status** | [**SecurityMonitoringRuleSeverity**](SecurityMonitoringRuleSeverity.md) | | | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V2::SecurityMonitoringRuleCaseCreate.new( status: null ) ``` - diff --git a/docs/v2/SecurityMonitoringRuleCreatePayload.md b/docs/v2/SecurityMonitoringRuleCreatePayload.md index 0c83ca0f80fa..8020b066b1b1 100644 --- a/docs/v2/SecurityMonitoringRuleCreatePayload.md +++ b/docs/v2/SecurityMonitoringRuleCreatePayload.md @@ -2,18 +2,18 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **cases** | [**Array<SecurityMonitoringRuleCaseCreate>**](SecurityMonitoringRuleCaseCreate.md) | Cases for generating signals. | | -| **filters** | [**Array<SecurityMonitoringFilter>**](SecurityMonitoringFilter.md) | Additional queries to filter matched events before they are processed. | [optional] | -| **has_extended_title** | **Boolean** | Whether the notifications include the triggering group-by values in their title. | [optional] | -| **is_enabled** | **Boolean** | Whether the rule is enabled. | | -| **message** | **String** | Message for generated signals. | | -| **name** | **String** | The name of the rule. | | -| **options** | [**SecurityMonitoringRuleOptions**](SecurityMonitoringRuleOptions.md) | | | -| **queries** | [**Array<SecurityMonitoringRuleQueryCreate>**](SecurityMonitoringRuleQueryCreate.md) | Queries for selecting logs which are part of the rule. | | -| **tags** | **Array<String>** | Tags for generated signals. | [optional] | -| **type** | [**SecurityMonitoringRuleTypeCreate**](SecurityMonitoringRuleTypeCreate.md) | | [optional] | +| Name | Type | Description | Notes | +| ---------------------- | ------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------- | ---------- | +| **cases** | [**Array<SecurityMonitoringRuleCaseCreate>**](SecurityMonitoringRuleCaseCreate.md) | Cases for generating signals. | | +| **filters** | [**Array<SecurityMonitoringFilter>**](SecurityMonitoringFilter.md) | Additional queries to filter matched events before they are processed. | [optional] | +| **has_extended_title** | **Boolean** | Whether the notifications include the triggering group-by values in their title. | [optional] | +| **is_enabled** | **Boolean** | Whether the rule is enabled. | | +| **message** | **String** | Message for generated signals. | | +| **name** | **String** | The name of the rule. | | +| **options** | [**SecurityMonitoringRuleOptions**](SecurityMonitoringRuleOptions.md) | | | +| **queries** | [**Array<SecurityMonitoringRuleQueryCreate>**](SecurityMonitoringRuleQueryCreate.md) | Queries for selecting logs which are part of the rule. | | +| **tags** | **Array<String>** | Tags for generated signals. | [optional] | +| **type** | [**SecurityMonitoringRuleTypeCreate**](SecurityMonitoringRuleTypeCreate.md) | | [optional] | ## Example @@ -33,4 +33,3 @@ instance = DatadogAPIClient::V2::SecurityMonitoringRuleCreatePayload.new( type: null ) ``` - diff --git a/docs/v2/SecurityMonitoringRuleDetectionMethod.md b/docs/v2/SecurityMonitoringRuleDetectionMethod.md index 613c54d346e6..4efbf008cf1b 100644 --- a/docs/v2/SecurityMonitoringRuleDetectionMethod.md +++ b/docs/v2/SecurityMonitoringRuleDetectionMethod.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::SecurityMonitoringRuleDetectionMethod.new() ``` - diff --git a/docs/v2/SecurityMonitoringRuleEvaluationWindow.md b/docs/v2/SecurityMonitoringRuleEvaluationWindow.md index aad137a1033a..8bb2b79353a7 100644 --- a/docs/v2/SecurityMonitoringRuleEvaluationWindow.md +++ b/docs/v2/SecurityMonitoringRuleEvaluationWindow.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::SecurityMonitoringRuleEvaluationWindow.new() ``` - diff --git a/docs/v2/SecurityMonitoringRuleKeepAlive.md b/docs/v2/SecurityMonitoringRuleKeepAlive.md index 9a5ff05cb0a0..1ae5401705bd 100644 --- a/docs/v2/SecurityMonitoringRuleKeepAlive.md +++ b/docs/v2/SecurityMonitoringRuleKeepAlive.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::SecurityMonitoringRuleKeepAlive.new() ``` - diff --git a/docs/v2/SecurityMonitoringRuleMaxSignalDuration.md b/docs/v2/SecurityMonitoringRuleMaxSignalDuration.md index b0deca6fdbce..d11b2d074ea4 100644 --- a/docs/v2/SecurityMonitoringRuleMaxSignalDuration.md +++ b/docs/v2/SecurityMonitoringRuleMaxSignalDuration.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::SecurityMonitoringRuleMaxSignalDuration.new() ``` - diff --git a/docs/v2/SecurityMonitoringRuleNewValueOptions.md b/docs/v2/SecurityMonitoringRuleNewValueOptions.md index 752a5f0a4ce9..e266d8da87df 100644 --- a/docs/v2/SecurityMonitoringRuleNewValueOptions.md +++ b/docs/v2/SecurityMonitoringRuleNewValueOptions.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **forget_after** | [**SecurityMonitoringRuleNewValueOptionsForgetAfter**](SecurityMonitoringRuleNewValueOptionsForgetAfter.md) | | [optional] | -| **learning_duration** | [**SecurityMonitoringRuleNewValueOptionsLearningDuration**](SecurityMonitoringRuleNewValueOptionsLearningDuration.md) | | [optional] | +| Name | Type | Description | Notes | +| --------------------- | --------------------------------------------------------------------------------------------------------------------- | ----------- | ---------- | +| **forget_after** | [**SecurityMonitoringRuleNewValueOptionsForgetAfter**](SecurityMonitoringRuleNewValueOptionsForgetAfter.md) | | [optional] | +| **learning_duration** | [**SecurityMonitoringRuleNewValueOptionsLearningDuration**](SecurityMonitoringRuleNewValueOptionsLearningDuration.md) | | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::SecurityMonitoringRuleNewValueOptions.new( learning_duration: null ) ``` - diff --git a/docs/v2/SecurityMonitoringRuleNewValueOptionsForgetAfter.md b/docs/v2/SecurityMonitoringRuleNewValueOptionsForgetAfter.md index bf66243dcf16..8aa8d15e2b7e 100644 --- a/docs/v2/SecurityMonitoringRuleNewValueOptionsForgetAfter.md +++ b/docs/v2/SecurityMonitoringRuleNewValueOptionsForgetAfter.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::SecurityMonitoringRuleNewValueOptionsForgetAfter.new() ``` - diff --git a/docs/v2/SecurityMonitoringRuleNewValueOptionsLearningDuration.md b/docs/v2/SecurityMonitoringRuleNewValueOptionsLearningDuration.md index 0e2db22deb7b..5ae31c604e97 100644 --- a/docs/v2/SecurityMonitoringRuleNewValueOptionsLearningDuration.md +++ b/docs/v2/SecurityMonitoringRuleNewValueOptionsLearningDuration.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::SecurityMonitoringRuleNewValueOptionsLearningDuration.new() ``` - diff --git a/docs/v2/SecurityMonitoringRuleOptions.md b/docs/v2/SecurityMonitoringRuleOptions.md index 6681cce32622..465e298ea897 100644 --- a/docs/v2/SecurityMonitoringRuleOptions.md +++ b/docs/v2/SecurityMonitoringRuleOptions.md @@ -2,13 +2,13 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **detection_method** | [**SecurityMonitoringRuleDetectionMethod**](SecurityMonitoringRuleDetectionMethod.md) | | [optional] | -| **evaluation_window** | [**SecurityMonitoringRuleEvaluationWindow**](SecurityMonitoringRuleEvaluationWindow.md) | | [optional] | -| **keep_alive** | [**SecurityMonitoringRuleKeepAlive**](SecurityMonitoringRuleKeepAlive.md) | | [optional] | -| **max_signal_duration** | [**SecurityMonitoringRuleMaxSignalDuration**](SecurityMonitoringRuleMaxSignalDuration.md) | | [optional] | -| **new_value_options** | [**SecurityMonitoringRuleNewValueOptions**](SecurityMonitoringRuleNewValueOptions.md) | | [optional] | +| Name | Type | Description | Notes | +| ----------------------- | ----------------------------------------------------------------------------------------- | ----------- | ---------- | +| **detection_method** | [**SecurityMonitoringRuleDetectionMethod**](SecurityMonitoringRuleDetectionMethod.md) | | [optional] | +| **evaluation_window** | [**SecurityMonitoringRuleEvaluationWindow**](SecurityMonitoringRuleEvaluationWindow.md) | | [optional] | +| **keep_alive** | [**SecurityMonitoringRuleKeepAlive**](SecurityMonitoringRuleKeepAlive.md) | | [optional] | +| **max_signal_duration** | [**SecurityMonitoringRuleMaxSignalDuration**](SecurityMonitoringRuleMaxSignalDuration.md) | | [optional] | +| **new_value_options** | [**SecurityMonitoringRuleNewValueOptions**](SecurityMonitoringRuleNewValueOptions.md) | | [optional] | ## Example @@ -23,4 +23,3 @@ instance = DatadogAPIClient::V2::SecurityMonitoringRuleOptions.new( new_value_options: null ) ``` - diff --git a/docs/v2/SecurityMonitoringRuleQuery.md b/docs/v2/SecurityMonitoringRuleQuery.md index f6324590537c..62c604fce249 100644 --- a/docs/v2/SecurityMonitoringRuleQuery.md +++ b/docs/v2/SecurityMonitoringRuleQuery.md @@ -2,15 +2,15 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **agent_rule** | [**SecurityMonitoringRuntimeAgentRule**](SecurityMonitoringRuntimeAgentRule.md) | | [optional] | -| **aggregation** | [**SecurityMonitoringRuleQueryAggregation**](SecurityMonitoringRuleQueryAggregation.md) | | [optional] | -| **distinct_fields** | **Array<String>** | Field for which the cardinality is measured. Sent as an array. | [optional] | -| **group_by_fields** | **Array<String>** | Fields to group by. | [optional] | -| **metric** | **String** | The target field to aggregate over when using the sum or max aggregations. | [optional] | -| **name** | **String** | Name of the query. | [optional] | -| **query** | **String** | Query to run on logs. | [optional] | +| Name | Type | Description | Notes | +| ------------------- | --------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | ---------- | +| **agent_rule** | [**SecurityMonitoringRuntimeAgentRule**](SecurityMonitoringRuntimeAgentRule.md) | | [optional] | +| **aggregation** | [**SecurityMonitoringRuleQueryAggregation**](SecurityMonitoringRuleQueryAggregation.md) | | [optional] | +| **distinct_fields** | **Array<String>** | Field for which the cardinality is measured. Sent as an array. | [optional] | +| **group_by_fields** | **Array<String>** | Fields to group by. | [optional] | +| **metric** | **String** | The target field to aggregate over when using the sum or max aggregations. | [optional] | +| **name** | **String** | Name of the query. | [optional] | +| **query** | **String** | Query to run on logs. | [optional] | ## Example @@ -27,4 +27,3 @@ instance = DatadogAPIClient::V2::SecurityMonitoringRuleQuery.new( query: null ) ``` - diff --git a/docs/v2/SecurityMonitoringRuleQueryAggregation.md b/docs/v2/SecurityMonitoringRuleQueryAggregation.md index 82e2f6473b51..857266b1b929 100644 --- a/docs/v2/SecurityMonitoringRuleQueryAggregation.md +++ b/docs/v2/SecurityMonitoringRuleQueryAggregation.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::SecurityMonitoringRuleQueryAggregation.new() ``` - diff --git a/docs/v2/SecurityMonitoringRuleQueryCreate.md b/docs/v2/SecurityMonitoringRuleQueryCreate.md index f4721d965834..ac4d081a629c 100644 --- a/docs/v2/SecurityMonitoringRuleQueryCreate.md +++ b/docs/v2/SecurityMonitoringRuleQueryCreate.md @@ -2,15 +2,15 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **agent_rule** | [**SecurityMonitoringRuntimeAgentRule**](SecurityMonitoringRuntimeAgentRule.md) | | [optional] | -| **aggregation** | [**SecurityMonitoringRuleQueryAggregation**](SecurityMonitoringRuleQueryAggregation.md) | | [optional] | -| **distinct_fields** | **Array<String>** | Field for which the cardinality is measured. Sent as an array. | [optional] | -| **group_by_fields** | **Array<String>** | Fields to group by. | [optional] | -| **metric** | **String** | The target field to aggregate over when using the sum or max aggregations. | [optional] | -| **name** | **String** | Name of the query. | [optional] | -| **query** | **String** | Query to run on logs. | | +| Name | Type | Description | Notes | +| ------------------- | --------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | ---------- | +| **agent_rule** | [**SecurityMonitoringRuntimeAgentRule**](SecurityMonitoringRuntimeAgentRule.md) | | [optional] | +| **aggregation** | [**SecurityMonitoringRuleQueryAggregation**](SecurityMonitoringRuleQueryAggregation.md) | | [optional] | +| **distinct_fields** | **Array<String>** | Field for which the cardinality is measured. Sent as an array. | [optional] | +| **group_by_fields** | **Array<String>** | Fields to group by. | [optional] | +| **metric** | **String** | The target field to aggregate over when using the sum or max aggregations. | [optional] | +| **name** | **String** | Name of the query. | [optional] | +| **query** | **String** | Query to run on logs. | | ## Example @@ -27,4 +27,3 @@ instance = DatadogAPIClient::V2::SecurityMonitoringRuleQueryCreate.new( query: a > 3 ) ``` - diff --git a/docs/v2/SecurityMonitoringRuleResponse.md b/docs/v2/SecurityMonitoringRuleResponse.md index 5a925e31707f..37aa3fd97311 100644 --- a/docs/v2/SecurityMonitoringRuleResponse.md +++ b/docs/v2/SecurityMonitoringRuleResponse.md @@ -2,25 +2,25 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **cases** | [**Array<SecurityMonitoringRuleCase>**](SecurityMonitoringRuleCase.md) | Cases for generating signals. | [optional] | -| **created_at** | **Integer** | When the rule was created, timestamp in milliseconds. | [optional] | -| **creation_author_id** | **Integer** | User ID of the user who created the rule. | [optional] | -| **filters** | [**Array<SecurityMonitoringFilter>**](SecurityMonitoringFilter.md) | Additional queries to filter matched events before they are processed. | [optional] | -| **has_extended_title** | **Boolean** | Whether the notifications include the triggering group-by values in their title. | [optional] | -| **id** | **String** | The ID of the rule. | [optional] | -| **is_default** | **Boolean** | Whether the rule is included by default. | [optional] | -| **is_deleted** | **Boolean** | Whether the rule has been deleted. | [optional] | -| **is_enabled** | **Boolean** | Whether the rule is enabled. | [optional] | -| **message** | **String** | Message for generated signals. | [optional] | -| **name** | **String** | The name of the rule. | [optional] | -| **options** | [**SecurityMonitoringRuleOptions**](SecurityMonitoringRuleOptions.md) | | [optional] | -| **queries** | [**Array<SecurityMonitoringRuleQuery>**](SecurityMonitoringRuleQuery.md) | Queries for selecting logs which are part of the rule. | [optional] | -| **tags** | **Array<String>** | Tags for generated signals. | [optional] | -| **type** | [**SecurityMonitoringRuleTypeRead**](SecurityMonitoringRuleTypeRead.md) | | [optional] | -| **update_author_id** | **Integer** | User ID of the user who updated the rule. | [optional] | -| **version** | **Integer** | The version of the rule. | [optional] | +| Name | Type | Description | Notes | +| ---------------------- | ------------------------------------------------------------------------------ | -------------------------------------------------------------------------------- | ---------- | +| **cases** | [**Array<SecurityMonitoringRuleCase>**](SecurityMonitoringRuleCase.md) | Cases for generating signals. | [optional] | +| **created_at** | **Integer** | When the rule was created, timestamp in milliseconds. | [optional] | +| **creation_author_id** | **Integer** | User ID of the user who created the rule. | [optional] | +| **filters** | [**Array<SecurityMonitoringFilter>**](SecurityMonitoringFilter.md) | Additional queries to filter matched events before they are processed. | [optional] | +| **has_extended_title** | **Boolean** | Whether the notifications include the triggering group-by values in their title. | [optional] | +| **id** | **String** | The ID of the rule. | [optional] | +| **is_default** | **Boolean** | Whether the rule is included by default. | [optional] | +| **is_deleted** | **Boolean** | Whether the rule has been deleted. | [optional] | +| **is_enabled** | **Boolean** | Whether the rule is enabled. | [optional] | +| **message** | **String** | Message for generated signals. | [optional] | +| **name** | **String** | The name of the rule. | [optional] | +| **options** | [**SecurityMonitoringRuleOptions**](SecurityMonitoringRuleOptions.md) | | [optional] | +| **queries** | [**Array<SecurityMonitoringRuleQuery>**](SecurityMonitoringRuleQuery.md) | Queries for selecting logs which are part of the rule. | [optional] | +| **tags** | **Array<String>** | Tags for generated signals. | [optional] | +| **type** | [**SecurityMonitoringRuleTypeRead**](SecurityMonitoringRuleTypeRead.md) | | [optional] | +| **update_author_id** | **Integer** | User ID of the user who updated the rule. | [optional] | +| **version** | **Integer** | The version of the rule. | [optional] | ## Example @@ -47,4 +47,3 @@ instance = DatadogAPIClient::V2::SecurityMonitoringRuleResponse.new( version: null ) ``` - diff --git a/docs/v2/SecurityMonitoringRuleSeverity.md b/docs/v2/SecurityMonitoringRuleSeverity.md index feb89247a8a6..d71740365774 100644 --- a/docs/v2/SecurityMonitoringRuleSeverity.md +++ b/docs/v2/SecurityMonitoringRuleSeverity.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::SecurityMonitoringRuleSeverity.new() ``` - diff --git a/docs/v2/SecurityMonitoringRuleTypeCreate.md b/docs/v2/SecurityMonitoringRuleTypeCreate.md index 088e2696c55e..87c63f1c325e 100644 --- a/docs/v2/SecurityMonitoringRuleTypeCreate.md +++ b/docs/v2/SecurityMonitoringRuleTypeCreate.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::SecurityMonitoringRuleTypeCreate.new() ``` - diff --git a/docs/v2/SecurityMonitoringRuleTypeRead.md b/docs/v2/SecurityMonitoringRuleTypeRead.md index 4a5ed30152a9..e1d9b6e6dbd9 100644 --- a/docs/v2/SecurityMonitoringRuleTypeRead.md +++ b/docs/v2/SecurityMonitoringRuleTypeRead.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::SecurityMonitoringRuleTypeRead.new() ``` - diff --git a/docs/v2/SecurityMonitoringRuleUpdatePayload.md b/docs/v2/SecurityMonitoringRuleUpdatePayload.md index 44ae363e9e44..1bc9798fec9e 100644 --- a/docs/v2/SecurityMonitoringRuleUpdatePayload.md +++ b/docs/v2/SecurityMonitoringRuleUpdatePayload.md @@ -2,18 +2,18 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **cases** | [**Array<SecurityMonitoringRuleCase>**](SecurityMonitoringRuleCase.md) | Cases for generating signals. | [optional] | -| **filters** | [**Array<SecurityMonitoringFilter>**](SecurityMonitoringFilter.md) | Additional queries to filter matched events before they are processed. | [optional] | -| **has_extended_title** | **Boolean** | Whether the notifications include the triggering group-by values in their title. | [optional] | -| **is_enabled** | **Boolean** | Whether the rule is enabled. | [optional] | -| **message** | **String** | Message for generated signals. | [optional] | -| **name** | **String** | Name of the rule. | [optional] | -| **options** | [**SecurityMonitoringRuleOptions**](SecurityMonitoringRuleOptions.md) | | [optional] | -| **queries** | [**Array<SecurityMonitoringRuleQuery>**](SecurityMonitoringRuleQuery.md) | Queries for selecting logs which are part of the rule. | [optional] | -| **tags** | **Array<String>** | Tags for generated signals. | [optional] | -| **version** | **Integer** | The version of the rule being updated. | [optional] | +| Name | Type | Description | Notes | +| ---------------------- | ------------------------------------------------------------------------------ | -------------------------------------------------------------------------------- | ---------- | +| **cases** | [**Array<SecurityMonitoringRuleCase>**](SecurityMonitoringRuleCase.md) | Cases for generating signals. | [optional] | +| **filters** | [**Array<SecurityMonitoringFilter>**](SecurityMonitoringFilter.md) | Additional queries to filter matched events before they are processed. | [optional] | +| **has_extended_title** | **Boolean** | Whether the notifications include the triggering group-by values in their title. | [optional] | +| **is_enabled** | **Boolean** | Whether the rule is enabled. | [optional] | +| **message** | **String** | Message for generated signals. | [optional] | +| **name** | **String** | Name of the rule. | [optional] | +| **options** | [**SecurityMonitoringRuleOptions**](SecurityMonitoringRuleOptions.md) | | [optional] | +| **queries** | [**Array<SecurityMonitoringRuleQuery>**](SecurityMonitoringRuleQuery.md) | Queries for selecting logs which are part of the rule. | [optional] | +| **tags** | **Array<String>** | Tags for generated signals. | [optional] | +| **version** | **Integer** | The version of the rule being updated. | [optional] | ## Example @@ -33,4 +33,3 @@ instance = DatadogAPIClient::V2::SecurityMonitoringRuleUpdatePayload.new( version: 1 ) ``` - diff --git a/docs/v2/SecurityMonitoringRuntimeAgentRule.md b/docs/v2/SecurityMonitoringRuntimeAgentRule.md index 360c8f724f75..5346e106b0b7 100644 --- a/docs/v2/SecurityMonitoringRuntimeAgentRule.md +++ b/docs/v2/SecurityMonitoringRuntimeAgentRule.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **agent_rule_id** | **String** | The Agent rule ID. Must be unique within the rule. | [optional] | -| **expression** | **String** | A Runtime Security expression determines what activity should be collected by the Datadog Agent. These logical expressions can use predefined operators and attributes. Tags cannot be used in Runtime Security expressions. Instead, allow or deny based on tags under the advanced option. | [optional] | +| Name | Type | Description | Notes | +| ----------------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| **agent_rule_id** | **String** | The Agent rule ID. Must be unique within the rule. | [optional] | +| **expression** | **String** | A Runtime Security expression determines what activity should be collected by the Datadog Agent. These logical expressions can use predefined operators and attributes. Tags cannot be used in Runtime Security expressions. Instead, allow or deny based on tags under the advanced option. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::SecurityMonitoringRuntimeAgentRule.new( expression: null ) ``` - diff --git a/docs/v2/SecurityMonitoringSignal.md b/docs/v2/SecurityMonitoringSignal.md index 39818cb6bc2b..f6502086f957 100644 --- a/docs/v2/SecurityMonitoringSignal.md +++ b/docs/v2/SecurityMonitoringSignal.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**SecurityMonitoringSignalAttributes**](SecurityMonitoringSignalAttributes.md) | | [optional] | -| **id** | **String** | The unique ID of the security signal. | [optional] | -| **type** | [**SecurityMonitoringSignalType**](SecurityMonitoringSignalType.md) | | [optional][default to 'signal'] | +| Name | Type | Description | Notes | +| -------------- | ------------------------------------------------------------------------------- | ------------------------------------- | --------------------------------------- | +| **attributes** | [**SecurityMonitoringSignalAttributes**](SecurityMonitoringSignalAttributes.md) | | [optional] | +| **id** | **String** | The unique ID of the security signal. | [optional] | +| **type** | [**SecurityMonitoringSignalType**](SecurityMonitoringSignalType.md) | | [optional][default to 'signal'] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V2::SecurityMonitoringSignal.new( type: null ) ``` - diff --git a/docs/v2/SecurityMonitoringSignalAttributes.md b/docs/v2/SecurityMonitoringSignalAttributes.md index 6e30572e1e38..4d0aad22fcde 100644 --- a/docs/v2/SecurityMonitoringSignalAttributes.md +++ b/docs/v2/SecurityMonitoringSignalAttributes.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | **Hash<String, Object>** | A JSON object of attributes in the security signal. | [optional] | -| **message** | **String** | The message in the security signal defined by the rule that generated the signal. | [optional] | -| **tags** | **Array<Object>** | An array of tags associated with the security signal. | [optional] | -| **timestamp** | **Time** | The timestamp of the security signal. | [optional] | +| Name | Type | Description | Notes | +| -------------- | ------------------------------ | --------------------------------------------------------------------------------- | ---------- | +| **attributes** | **Hash<String, Object>** | A JSON object of attributes in the security signal. | [optional] | +| **message** | **String** | The message in the security signal defined by the rule that generated the signal. | [optional] | +| **tags** | **Array<Object>** | An array of tags associated with the security signal. | [optional] | +| **timestamp** | **Time** | The timestamp of the security signal. | [optional] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V2::SecurityMonitoringSignalAttributes.new( timestamp: 2019-01-02T09:42:36.320Z ) ``` - diff --git a/docs/v2/SecurityMonitoringSignalListRequest.md b/docs/v2/SecurityMonitoringSignalListRequest.md index f82267fe7bc8..d992bb9254e4 100644 --- a/docs/v2/SecurityMonitoringSignalListRequest.md +++ b/docs/v2/SecurityMonitoringSignalListRequest.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **filter** | [**SecurityMonitoringSignalListRequestFilter**](SecurityMonitoringSignalListRequestFilter.md) | | [optional] | -| **page** | [**SecurityMonitoringSignalListRequestPage**](SecurityMonitoringSignalListRequestPage.md) | | [optional] | -| **sort** | [**SecurityMonitoringSignalsSort**](SecurityMonitoringSignalsSort.md) | | [optional] | +| Name | Type | Description | Notes | +| ---------- | --------------------------------------------------------------------------------------------- | ----------- | ---------- | +| **filter** | [**SecurityMonitoringSignalListRequestFilter**](SecurityMonitoringSignalListRequestFilter.md) | | [optional] | +| **page** | [**SecurityMonitoringSignalListRequestPage**](SecurityMonitoringSignalListRequestPage.md) | | [optional] | +| **sort** | [**SecurityMonitoringSignalsSort**](SecurityMonitoringSignalsSort.md) | | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V2::SecurityMonitoringSignalListRequest.new( sort: null ) ``` - diff --git a/docs/v2/SecurityMonitoringSignalListRequestFilter.md b/docs/v2/SecurityMonitoringSignalListRequestFilter.md index 2089cb2b4862..af66ce702dc4 100644 --- a/docs/v2/SecurityMonitoringSignalListRequestFilter.md +++ b/docs/v2/SecurityMonitoringSignalListRequestFilter.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **from** | **Time** | The minimum timestamp for requested security signals. | [optional] | -| **query** | **String** | Search query for listing security signals. | [optional] | -| **to** | **Time** | The maximum timestamp for requested security signals. | [optional] | +| Name | Type | Description | Notes | +| --------- | ---------- | ----------------------------------------------------- | ---------- | +| **from** | **Time** | The minimum timestamp for requested security signals. | [optional] | +| **query** | **String** | Search query for listing security signals. | [optional] | +| **to** | **Time** | The maximum timestamp for requested security signals. | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V2::SecurityMonitoringSignalListRequestFilter.new( to: 2019-01-03T09:42:36.320Z ) ``` - diff --git a/docs/v2/SecurityMonitoringSignalListRequestPage.md b/docs/v2/SecurityMonitoringSignalListRequestPage.md index 9ddeb501203a..daa4646a6e6a 100644 --- a/docs/v2/SecurityMonitoringSignalListRequestPage.md +++ b/docs/v2/SecurityMonitoringSignalListRequestPage.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **cursor** | **String** | A list of results using the cursor provided in the previous query. | [optional] | -| **limit** | **Integer** | The maximum number of security signals in the response. | [optional][default to 10] | +| Name | Type | Description | Notes | +| ---------- | ----------- | ------------------------------------------------------------------ | ------------------------- | +| **cursor** | **String** | A list of results using the cursor provided in the previous query. | [optional] | +| **limit** | **Integer** | The maximum number of security signals in the response. | [optional][default to 10] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::SecurityMonitoringSignalListRequestPage.new( limit: 25 ) ``` - diff --git a/docs/v2/SecurityMonitoringSignalType.md b/docs/v2/SecurityMonitoringSignalType.md index 1bfda856ff03..e783219c25cb 100644 --- a/docs/v2/SecurityMonitoringSignalType.md +++ b/docs/v2/SecurityMonitoringSignalType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::SecurityMonitoringSignalType.new() ``` - diff --git a/docs/v2/SecurityMonitoringSignalsListResponse.md b/docs/v2/SecurityMonitoringSignalsListResponse.md index 6482ac6cc1a0..f172a9cadccc 100644 --- a/docs/v2/SecurityMonitoringSignalsListResponse.md +++ b/docs/v2/SecurityMonitoringSignalsListResponse.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**Array<SecurityMonitoringSignal>**](SecurityMonitoringSignal.md) | An array of security signals matching the request. | [optional] | -| **links** | [**SecurityMonitoringSignalsListResponseLinks**](SecurityMonitoringSignalsListResponseLinks.md) | | [optional] | -| **meta** | [**SecurityMonitoringSignalsListResponseMeta**](SecurityMonitoringSignalsListResponseMeta.md) | | [optional] | +| Name | Type | Description | Notes | +| --------- | ----------------------------------------------------------------------------------------------- | -------------------------------------------------- | ---------- | +| **data** | [**Array<SecurityMonitoringSignal>**](SecurityMonitoringSignal.md) | An array of security signals matching the request. | [optional] | +| **links** | [**SecurityMonitoringSignalsListResponseLinks**](SecurityMonitoringSignalsListResponseLinks.md) | | [optional] | +| **meta** | [**SecurityMonitoringSignalsListResponseMeta**](SecurityMonitoringSignalsListResponseMeta.md) | | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V2::SecurityMonitoringSignalsListResponse.new( meta: null ) ``` - diff --git a/docs/v2/SecurityMonitoringSignalsListResponseLinks.md b/docs/v2/SecurityMonitoringSignalsListResponseLinks.md index 0e92117bd230..81e0294eed8d 100644 --- a/docs/v2/SecurityMonitoringSignalsListResponseLinks.md +++ b/docs/v2/SecurityMonitoringSignalsListResponseLinks.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **_next** | **String** | The link for the next set of results. **Note**: The request can also be made using the POST endpoint. | [optional] | +| Name | Type | Description | Notes | +| ---------- | ---------- | ----------------------------------------------------------------------------------------------------- | ---------- | +| **\_next** | **String** | The link for the next set of results. **Note**: The request can also be made using the POST endpoint. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::SecurityMonitoringSignalsListResponseLinks.new( _next: https://app.datadoghq.com/api/v2/security_monitoring/signals?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== ) ``` - diff --git a/docs/v2/SecurityMonitoringSignalsListResponseMeta.md b/docs/v2/SecurityMonitoringSignalsListResponseMeta.md index 6d182ace3b2b..97abbf75a059 100644 --- a/docs/v2/SecurityMonitoringSignalsListResponseMeta.md +++ b/docs/v2/SecurityMonitoringSignalsListResponseMeta.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **page** | [**SecurityMonitoringSignalsListResponseMetaPage**](SecurityMonitoringSignalsListResponseMetaPage.md) | | [optional] | +| Name | Type | Description | Notes | +| -------- | ----------------------------------------------------------------------------------------------------- | ----------- | ---------- | +| **page** | [**SecurityMonitoringSignalsListResponseMetaPage**](SecurityMonitoringSignalsListResponseMetaPage.md) | | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::SecurityMonitoringSignalsListResponseMeta.new( page: null ) ``` - diff --git a/docs/v2/SecurityMonitoringSignalsListResponseMetaPage.md b/docs/v2/SecurityMonitoringSignalsListResponseMetaPage.md index 48ef288657a4..57a2ebbb3424 100644 --- a/docs/v2/SecurityMonitoringSignalsListResponseMetaPage.md +++ b/docs/v2/SecurityMonitoringSignalsListResponseMetaPage.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| --------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | | **after** | **String** | The cursor used to get the next results, if any. To make the next request, use the same parameters with the addition of the `page[cursor]`. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::SecurityMonitoringSignalsListResponseMetaPage.n after: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ== ) ``` - diff --git a/docs/v2/SecurityMonitoringSignalsSort.md b/docs/v2/SecurityMonitoringSignalsSort.md index 2a64b080da74..1c14291f648f 100644 --- a/docs/v2/SecurityMonitoringSignalsSort.md +++ b/docs/v2/SecurityMonitoringSignalsSort.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::SecurityMonitoringSignalsSort.new() ``` - diff --git a/docs/v2/ServiceAccountCreateAttributes.md b/docs/v2/ServiceAccountCreateAttributes.md index 5ff872c66238..dcec3de2d351 100644 --- a/docs/v2/ServiceAccountCreateAttributes.md +++ b/docs/v2/ServiceAccountCreateAttributes.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **email** | **String** | The email of the user. | | -| **name** | **String** | The name of the user. | [optional] | -| **service_account** | **Boolean** | Whether the user is a service account. Must be true. | | -| **title** | **String** | The title of the user. | [optional] | +| Name | Type | Description | Notes | +| ------------------- | ----------- | ---------------------------------------------------- | ---------- | +| **email** | **String** | The email of the user. | | +| **name** | **String** | The name of the user. | [optional] | +| **service_account** | **Boolean** | Whether the user is a service account. Must be true. | | +| **title** | **String** | The title of the user. | [optional] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V2::ServiceAccountCreateAttributes.new( title: null ) ``` - diff --git a/docs/v2/ServiceAccountCreateData.md b/docs/v2/ServiceAccountCreateData.md index 54408370fadb..617f8ac2c7ce 100644 --- a/docs/v2/ServiceAccountCreateData.md +++ b/docs/v2/ServiceAccountCreateData.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**ServiceAccountCreateAttributes**](ServiceAccountCreateAttributes.md) | | | -| **relationships** | [**UserRelationships**](UserRelationships.md) | | [optional] | -| **type** | [**UsersType**](UsersType.md) | | [default to 'users'] | +| Name | Type | Description | Notes | +| ----------------- | ----------------------------------------------------------------------- | ----------- | ---------------------------- | +| **attributes** | [**ServiceAccountCreateAttributes**](ServiceAccountCreateAttributes.md) | | | +| **relationships** | [**UserRelationships**](UserRelationships.md) | | [optional] | +| **type** | [**UsersType**](UsersType.md) | | [default to 'users'] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V2::ServiceAccountCreateData.new( type: null ) ``` - diff --git a/docs/v2/ServiceAccountCreateRequest.md b/docs/v2/ServiceAccountCreateRequest.md index 3977a95a4064..a3619a4ea766 100644 --- a/docs/v2/ServiceAccountCreateRequest.md +++ b/docs/v2/ServiceAccountCreateRequest.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**ServiceAccountCreateData**](ServiceAccountCreateData.md) | | | +| Name | Type | Description | Notes | +| -------- | ----------------------------------------------------------- | ----------- | ----- | +| **data** | [**ServiceAccountCreateData**](ServiceAccountCreateData.md) | | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::ServiceAccountCreateRequest.new( data: null ) ``` - diff --git a/docs/v2/ServiceAccountsAPI.md b/docs/v2/ServiceAccountsAPI.md index 8f1869c5596b..24819e68cd3c 100644 --- a/docs/v2/ServiceAccountsAPI.md +++ b/docs/v2/ServiceAccountsAPI.md @@ -2,14 +2,13 @@ All URIs are relative to *https://api.datadoghq.com* -| Method | HTTP request | Description | -| ------ | ------------ | ----------- | -| [**create_service_account_application_key**](ServiceAccountsAPI.md#create_service_account_application_key) | **POST** /api/v2/service_accounts/{service_account_id}/application_keys | Create an application key for this service account | +| Method | HTTP request | Description | +| ---------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------- | +| [**create_service_account_application_key**](ServiceAccountsAPI.md#create_service_account_application_key) | **POST** /api/v2/service_accounts/{service_account_id}/application_keys | Create an application key for this service account | | [**delete_service_account_application_key**](ServiceAccountsAPI.md#delete_service_account_application_key) | **DELETE** /api/v2/service_accounts/{service_account_id}/application_keys/{app_key_id} | Delete an application key for this service account | -| [**get_service_account_application_key**](ServiceAccountsAPI.md#get_service_account_application_key) | **GET** /api/v2/service_accounts/{service_account_id}/application_keys/{app_key_id} | Get one application key for this service account | -| [**list_service_account_application_keys**](ServiceAccountsAPI.md#list_service_account_application_keys) | **GET** /api/v2/service_accounts/{service_account_id}/application_keys | List application keys for this service account | -| [**update_service_account_application_key**](ServiceAccountsAPI.md#update_service_account_application_key) | **PATCH** /api/v2/service_accounts/{service_account_id}/application_keys/{app_key_id} | Edit an application key for this service account | - +| [**get_service_account_application_key**](ServiceAccountsAPI.md#get_service_account_application_key) | **GET** /api/v2/service_accounts/{service_account_id}/application_keys/{app_key_id} | Get one application key for this service account | +| [**list_service_account_application_keys**](ServiceAccountsAPI.md#list_service_account_application_keys) | **GET** /api/v2/service_accounts/{service_account_id}/application_keys | List application keys for this service account | +| [**update_service_account_application_key**](ServiceAccountsAPI.md#update_service_account_application_key) | **PATCH** /api/v2/service_accounts/{service_account_id}/application_keys/{app_key_id} | Edit an application key for this service account | ## create_service_account_application_key @@ -23,7 +22,7 @@ Create an application key for this service account. require 'datadog_api_client' api_instance = DatadogAPIClient::V2::ServiceAccountsAPI.new service_account_id = '00000000-0000-0000-0000-000000000000' # String | The ID of the service account. -body = DatadogAPIClient::V2::ApplicationKeyCreateRequest.new({data: DatadogAPIClient::V2::ApplicationKeyCreateData.new({attributes: DatadogAPIClient::V2::ApplicationKeyCreateAttributes.new({name: 'Application Key for submitting metrics'}), type: DatadogAPIClient::V2::ApplicationKeysType::APPLICATION_KEYS})}) # ApplicationKeyCreateRequest | +body = DatadogAPIClient::V2::ApplicationKeyCreateRequest.new({data: DatadogAPIClient::V2::ApplicationKeyCreateData.new({attributes: DatadogAPIClient::V2::ApplicationKeyCreateAttributes.new({name: 'Application Key for submitting metrics'}), type: DatadogAPIClient::V2::ApplicationKeysType::APPLICATION_KEYS})}) # ApplicationKeyCreateRequest | begin # Create an application key for this service account @@ -54,10 +53,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **service_account_id** | **String** | The ID of the service account. | | -| **body** | [**ApplicationKeyCreateRequest**](ApplicationKeyCreateRequest.md) | | | +| Name | Type | Description | Notes | +| ---------------------- | ----------------------------------------------------------------- | ------------------------------ | ----- | +| **service_account_id** | **String** | The ID of the service account. | | +| **body** | [**ApplicationKeyCreateRequest**](ApplicationKeyCreateRequest.md) | | | ### Return type @@ -72,7 +71,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## delete_service_account_application_key > delete_service_account_application_key(service_account_id, app_key_id) @@ -115,10 +113,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **service_account_id** | **String** | The ID of the service account. | | -| **app_key_id** | **String** | The ID of the application key. | | +| Name | Type | Description | Notes | +| ---------------------- | ---------- | ------------------------------ | ----- | +| **service_account_id** | **String** | The ID of the service account. | | +| **app_key_id** | **String** | The ID of the application key. | | ### Return type @@ -133,7 +131,6 @@ nil (empty response body) - **Content-Type**: Not defined - **Accept**: application/json - ## get_service_account_application_key > get_service_account_application_key(service_account_id, app_key_id) @@ -177,10 +174,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **service_account_id** | **String** | The ID of the service account. | | -| **app_key_id** | **String** | The ID of the application key. | | +| Name | Type | Description | Notes | +| ---------------------- | ---------- | ------------------------------ | ----- | +| **service_account_id** | **String** | The ID of the service account. | | +| **app_key_id** | **String** | The ID of the application key. | | ### Return type @@ -195,7 +192,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## list_service_account_application_keys > list_service_account_application_keys(service_account_id, opts) @@ -246,15 +242,15 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **service_account_id** | **String** | The ID of the service account. | | -| **page_size** | **Integer** | Size for a given page. | [optional][default to 10] | -| **page_number** | **Integer** | Specific page number to return. | [optional][default to 0] | -| **sort** | **ApplicationKeysSort** | Application key attribute used to sort results. Sort order is ascending by default. In order to specify a descending sort, prefix the attribute with a minus sign. | [optional][default to 'name'] | -| **filter** | **String** | Filter application keys by the specified string. | [optional] | -| **filter_created_at_start** | **String** | Only include application keys created on or after the specified date. | [optional] | -| **filter_created_at_end** | **String** | Only include application keys created on or before the specified date. | [optional] | +| Name | Type | Description | Notes | +| --------------------------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------- | +| **service_account_id** | **String** | The ID of the service account. | | +| **page_size** | **Integer** | Size for a given page. | [optional][default to 10] | +| **page_number** | **Integer** | Specific page number to return. | [optional][default to 0] | +| **sort** | **ApplicationKeysSort** | Application key attribute used to sort results. Sort order is ascending by default. In order to specify a descending sort, prefix the attribute with a minus sign. | [optional][default to 'name'] | +| **filter** | **String** | Filter application keys by the specified string. | [optional] | +| **filter_created_at_start** | **String** | Only include application keys created on or after the specified date. | [optional] | +| **filter_created_at_end** | **String** | Only include application keys created on or before the specified date. | [optional] | ### Return type @@ -269,7 +265,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## update_service_account_application_key > update_service_account_application_key(service_account_id, app_key_id, body) @@ -283,7 +278,7 @@ require 'datadog_api_client' api_instance = DatadogAPIClient::V2::ServiceAccountsAPI.new service_account_id = '00000000-0000-0000-0000-000000000000' # String | The ID of the service account. app_key_id = 'app_key_id_example' # String | The ID of the application key. -body = DatadogAPIClient::V2::ApplicationKeyUpdateRequest.new({data: DatadogAPIClient::V2::ApplicationKeyUpdateData.new({attributes: DatadogAPIClient::V2::ApplicationKeyUpdateAttributes.new({name: 'Application Key for submitting metrics'}), id: '00112233-4455-6677-8899-aabbccddeeff', type: DatadogAPIClient::V2::ApplicationKeysType::APPLICATION_KEYS})}) # ApplicationKeyUpdateRequest | +body = DatadogAPIClient::V2::ApplicationKeyUpdateRequest.new({data: DatadogAPIClient::V2::ApplicationKeyUpdateData.new({attributes: DatadogAPIClient::V2::ApplicationKeyUpdateAttributes.new({name: 'Application Key for submitting metrics'}), id: '00112233-4455-6677-8899-aabbccddeeff', type: DatadogAPIClient::V2::ApplicationKeysType::APPLICATION_KEYS})}) # ApplicationKeyUpdateRequest | begin # Edit an application key for this service account @@ -314,11 +309,11 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **service_account_id** | **String** | The ID of the service account. | | -| **app_key_id** | **String** | The ID of the application key. | | -| **body** | [**ApplicationKeyUpdateRequest**](ApplicationKeyUpdateRequest.md) | | | +| Name | Type | Description | Notes | +| ---------------------- | ----------------------------------------------------------------- | ------------------------------ | ----- | +| **service_account_id** | **String** | The ID of the service account. | | +| **app_key_id** | **String** | The ID of the application key. | | +| **body** | [**ApplicationKeyUpdateRequest**](ApplicationKeyUpdateRequest.md) | | | ### Return type @@ -332,4 +327,3 @@ end - **Content-Type**: application/json - **Accept**: application/json - diff --git a/docs/v2/User.md b/docs/v2/User.md index 9a7db22c482b..bdef76d0cfb8 100644 --- a/docs/v2/User.md +++ b/docs/v2/User.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**UserAttributes**](UserAttributes.md) | | [optional] | -| **id** | **String** | ID of the user. | [optional] | -| **relationships** | [**UserResponseRelationships**](UserResponseRelationships.md) | | [optional] | -| **type** | [**UsersType**](UsersType.md) | | [optional][default to 'users'] | +| Name | Type | Description | Notes | +| ----------------- | ------------------------------------------------------------- | --------------- | -------------------------------------- | +| **attributes** | [**UserAttributes**](UserAttributes.md) | | [optional] | +| **id** | **String** | ID of the user. | [optional] | +| **relationships** | [**UserResponseRelationships**](UserResponseRelationships.md) | | [optional] | +| **type** | [**UsersType**](UsersType.md) | | [optional][default to 'users'] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V2::User.new( type: null ) ``` - diff --git a/docs/v2/UserAttributes.md b/docs/v2/UserAttributes.md index 0994d91f083d..03939143efd4 100644 --- a/docs/v2/UserAttributes.md +++ b/docs/v2/UserAttributes.md @@ -2,19 +2,19 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **created_at** | **Time** | Creation time of the user. | [optional] | -| **disabled** | **Boolean** | Whether the user is disabled. | [optional] | -| **email** | **String** | Email of the user. | [optional] | -| **handle** | **String** | Handle of the user. | [optional] | -| **icon** | **String** | URL of the user's icon. | [optional] | -| **modified_at** | **Time** | Time that the user was last modified. | [optional] | -| **name** | **String** | Name of the user. | [optional] | +| Name | Type | Description | Notes | +| ------------------- | ----------- | -------------------------------------- | ---------- | +| **created_at** | **Time** | Creation time of the user. | [optional] | +| **disabled** | **Boolean** | Whether the user is disabled. | [optional] | +| **email** | **String** | Email of the user. | [optional] | +| **handle** | **String** | Handle of the user. | [optional] | +| **icon** | **String** | URL of the user's icon. | [optional] | +| **modified_at** | **Time** | Time that the user was last modified. | [optional] | +| **name** | **String** | Name of the user. | [optional] | | **service_account** | **Boolean** | Whether the user is a service account. | [optional] | -| **status** | **String** | Status of the user. | [optional] | -| **title** | **String** | Title of the user. | [optional] | -| **verified** | **Boolean** | Whether the user is verified. | [optional] | +| **status** | **String** | Status of the user. | [optional] | +| **title** | **String** | Title of the user. | [optional] | +| **verified** | **Boolean** | Whether the user is verified. | [optional] | ## Example @@ -35,4 +35,3 @@ instance = DatadogAPIClient::V2::UserAttributes.new( verified: null ) ``` - diff --git a/docs/v2/UserCreateAttributes.md b/docs/v2/UserCreateAttributes.md index 370f38d1caf8..93a6feea384f 100644 --- a/docs/v2/UserCreateAttributes.md +++ b/docs/v2/UserCreateAttributes.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **email** | **String** | The email of the user. | | -| **name** | **String** | The name of the user. | [optional] | +| Name | Type | Description | Notes | +| --------- | ---------- | ---------------------- | ---------- | +| **email** | **String** | The email of the user. | | +| **name** | **String** | The name of the user. | [optional] | | **title** | **String** | The title of the user. | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V2::UserCreateAttributes.new( title: null ) ``` - diff --git a/docs/v2/UserCreateData.md b/docs/v2/UserCreateData.md index 959be5b43b8d..09dd89772210 100644 --- a/docs/v2/UserCreateData.md +++ b/docs/v2/UserCreateData.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**UserCreateAttributes**](UserCreateAttributes.md) | | | -| **relationships** | [**UserRelationships**](UserRelationships.md) | | [optional] | -| **type** | [**UsersType**](UsersType.md) | | [default to 'users'] | +| Name | Type | Description | Notes | +| ----------------- | --------------------------------------------------- | ----------- | ---------------------------- | +| **attributes** | [**UserCreateAttributes**](UserCreateAttributes.md) | | | +| **relationships** | [**UserRelationships**](UserRelationships.md) | | [optional] | +| **type** | [**UsersType**](UsersType.md) | | [default to 'users'] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V2::UserCreateData.new( type: null ) ``` - diff --git a/docs/v2/UserCreateRequest.md b/docs/v2/UserCreateRequest.md index 109e4a0cc0c8..7228d62b5f6f 100644 --- a/docs/v2/UserCreateRequest.md +++ b/docs/v2/UserCreateRequest.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**UserCreateData**](UserCreateData.md) | | | +| Name | Type | Description | Notes | +| -------- | --------------------------------------- | ----------- | ----- | +| **data** | [**UserCreateData**](UserCreateData.md) | | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::UserCreateRequest.new( data: null ) ``` - diff --git a/docs/v2/UserInvitationData.md b/docs/v2/UserInvitationData.md index 195c25078fb3..1799ac1b8447 100644 --- a/docs/v2/UserInvitationData.md +++ b/docs/v2/UserInvitationData.md @@ -2,10 +2,10 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **relationships** | [**UserInvitationRelationships**](UserInvitationRelationships.md) | | | -| **type** | [**UserInvitationsType**](UserInvitationsType.md) | | [default to 'user_invitations'] | +| Name | Type | Description | Notes | +| ----------------- | ----------------------------------------------------------------- | ----------- | --------------------------------------- | +| **relationships** | [**UserInvitationRelationships**](UserInvitationRelationships.md) | | | +| **type** | [**UserInvitationsType**](UserInvitationsType.md) | | [default to 'user_invitations'] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::UserInvitationData.new( type: null ) ``` - diff --git a/docs/v2/UserInvitationDataAttributes.md b/docs/v2/UserInvitationDataAttributes.md index 2e233b9b92db..e4e34d4d4491 100644 --- a/docs/v2/UserInvitationDataAttributes.md +++ b/docs/v2/UserInvitationDataAttributes.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **created_at** | **Time** | Creation time of the user invitation. | [optional] | -| **expires_at** | **Time** | Time of invitation expiration. | [optional] | -| **invite_type** | **String** | Type of invitation. | [optional] | -| **uuid** | **String** | UUID of the user invitation. | [optional] | +| Name | Type | Description | Notes | +| --------------- | ---------- | ------------------------------------- | ---------- | +| **created_at** | **Time** | Creation time of the user invitation. | [optional] | +| **expires_at** | **Time** | Time of invitation expiration. | [optional] | +| **invite_type** | **String** | Type of invitation. | [optional] | +| **uuid** | **String** | UUID of the user invitation. | [optional] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V2::UserInvitationDataAttributes.new( uuid: null ) ``` - diff --git a/docs/v2/UserInvitationRelationships.md b/docs/v2/UserInvitationRelationships.md index 216baa7fd642..206d83cfe8ec 100644 --- a/docs/v2/UserInvitationRelationships.md +++ b/docs/v2/UserInvitationRelationships.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **user** | [**RelationshipToUser**](RelationshipToUser.md) | | | +| Name | Type | Description | Notes | +| -------- | ----------------------------------------------- | ----------- | ----- | +| **user** | [**RelationshipToUser**](RelationshipToUser.md) | | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::UserInvitationRelationships.new( user: null ) ``` - diff --git a/docs/v2/UserInvitationResponse.md b/docs/v2/UserInvitationResponse.md index 3918bceaca6c..40f3da30159c 100644 --- a/docs/v2/UserInvitationResponse.md +++ b/docs/v2/UserInvitationResponse.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**UserInvitationResponseData**](UserInvitationResponseData.md) | | [optional] | +| Name | Type | Description | Notes | +| -------- | --------------------------------------------------------------- | ----------- | ---------- | +| **data** | [**UserInvitationResponseData**](UserInvitationResponseData.md) | | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::UserInvitationResponse.new( data: null ) ``` - diff --git a/docs/v2/UserInvitationResponseData.md b/docs/v2/UserInvitationResponseData.md index 4890231eff87..7e9ec7879d30 100644 --- a/docs/v2/UserInvitationResponseData.md +++ b/docs/v2/UserInvitationResponseData.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**UserInvitationDataAttributes**](UserInvitationDataAttributes.md) | | [optional] | -| **id** | **String** | ID of the user invitation. | [optional] | -| **type** | [**UserInvitationsType**](UserInvitationsType.md) | | [optional][default to 'user_invitations'] | +| Name | Type | Description | Notes | +| -------------- | ------------------------------------------------------------------- | -------------------------- | ------------------------------------------------- | +| **attributes** | [**UserInvitationDataAttributes**](UserInvitationDataAttributes.md) | | [optional] | +| **id** | **String** | ID of the user invitation. | [optional] | +| **type** | [**UserInvitationsType**](UserInvitationsType.md) | | [optional][default to 'user_invitations'] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V2::UserInvitationResponseData.new( type: null ) ``` - diff --git a/docs/v2/UserInvitationsRequest.md b/docs/v2/UserInvitationsRequest.md index 21aa58ff4076..7ace447cf15d 100644 --- a/docs/v2/UserInvitationsRequest.md +++ b/docs/v2/UserInvitationsRequest.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**Array<UserInvitationData>**](UserInvitationData.md) | List of user invitations. | | +| Name | Type | Description | Notes | +| -------- | ------------------------------------------------------------ | ------------------------- | ----- | +| **data** | [**Array<UserInvitationData>**](UserInvitationData.md) | List of user invitations. | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::UserInvitationsRequest.new( data: [] ) ``` - diff --git a/docs/v2/UserInvitationsResponse.md b/docs/v2/UserInvitationsResponse.md index 6b2ad0dd6a60..2be708f28b14 100644 --- a/docs/v2/UserInvitationsResponse.md +++ b/docs/v2/UserInvitationsResponse.md @@ -2,8 +2,8 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| -------- | ---------------------------------------------------------------------------- | -------------------------- | ---------- | | **data** | [**Array<UserInvitationResponseData>**](UserInvitationResponseData.md) | Array of user invitations. | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::UserInvitationsResponse.new( data: null ) ``` - diff --git a/docs/v2/UserInvitationsType.md b/docs/v2/UserInvitationsType.md index abfaeac2565d..82456fc9a1cb 100644 --- a/docs/v2/UserInvitationsType.md +++ b/docs/v2/UserInvitationsType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::UserInvitationsType.new() ``` - diff --git a/docs/v2/UserRelationships.md b/docs/v2/UserRelationships.md index 4df08e1562ef..b0ce929bd353 100644 --- a/docs/v2/UserRelationships.md +++ b/docs/v2/UserRelationships.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **roles** | [**RelationshipToRoles**](RelationshipToRoles.md) | | [optional] | +| Name | Type | Description | Notes | +| --------- | ------------------------------------------------- | ----------- | ---------- | +| **roles** | [**RelationshipToRoles**](RelationshipToRoles.md) | | [optional] | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::UserRelationships.new( roles: null ) ``` - diff --git a/docs/v2/UserResponse.md b/docs/v2/UserResponse.md index cbf98dd76412..b3bacd716539 100644 --- a/docs/v2/UserResponse.md +++ b/docs/v2/UserResponse.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**User**](User.md) | | [optional] | +| Name | Type | Description | Notes | +| ------------ | ------------------------------------------------------------------------ | ------------------------------------- | ---------- | +| **data** | [**User**](User.md) | | [optional] | | **included** | [**Array<UserResponseIncludedItem>**](UserResponseIncludedItem.md) | Array of objects related to the user. | [optional] | ## Example @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V2::UserResponse.new( included: null ) ``` - diff --git a/docs/v2/UserResponseIncludedItem.md b/docs/v2/UserResponseIncludedItem.md index 1ba16789a40a..a6d4cef5718a 100644 --- a/docs/v2/UserResponseIncludedItem.md +++ b/docs/v2/UserResponseIncludedItem.md @@ -38,8 +38,8 @@ DatadogAPIClient::V2::UserResponseIncludedItem.build(data_that_doesnt_match) #### Parameters -| Name | Type | Description | -| ---- | ---- | ----------- | +| Name | Type | Description | +| -------- | --------- | -------------------------------------------------- | | **data** | **Mixed** | data to be matched against the list of oneOf items | #### Return type @@ -48,4 +48,3 @@ DatadogAPIClient::V2::UserResponseIncludedItem.build(data_that_doesnt_match) - `Permission` - `Role` - `nil` (if no type matches) - diff --git a/docs/v2/UserResponseRelationships.md b/docs/v2/UserResponseRelationships.md index 488a3d735c55..b90e42c27218 100644 --- a/docs/v2/UserResponseRelationships.md +++ b/docs/v2/UserResponseRelationships.md @@ -2,12 +2,12 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **org** | [**RelationshipToOrganization**](RelationshipToOrganization.md) | | [optional] | -| **other_orgs** | [**RelationshipToOrganizations**](RelationshipToOrganizations.md) | | [optional] | -| **other_users** | [**RelationshipToUsers**](RelationshipToUsers.md) | | [optional] | -| **roles** | [**RelationshipToRoles**](RelationshipToRoles.md) | | [optional] | +| Name | Type | Description | Notes | +| --------------- | ----------------------------------------------------------------- | ----------- | ---------- | +| **org** | [**RelationshipToOrganization**](RelationshipToOrganization.md) | | [optional] | +| **other_orgs** | [**RelationshipToOrganizations**](RelationshipToOrganizations.md) | | [optional] | +| **other_users** | [**RelationshipToUsers**](RelationshipToUsers.md) | | [optional] | +| **roles** | [**RelationshipToRoles**](RelationshipToRoles.md) | | [optional] | ## Example @@ -21,4 +21,3 @@ instance = DatadogAPIClient::V2::UserResponseRelationships.new( roles: null ) ``` - diff --git a/docs/v2/UserUpdateAttributes.md b/docs/v2/UserUpdateAttributes.md index edee3471d596..b72a438774f0 100644 --- a/docs/v2/UserUpdateAttributes.md +++ b/docs/v2/UserUpdateAttributes.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | +| Name | Type | Description | Notes | +| ------------ | ----------- | ----------------------------------- | ---------- | | **disabled** | **Boolean** | If the user is enabled or disabled. | [optional] | -| **email** | **String** | The email of the user. | [optional] | -| **name** | **String** | The name of the user. | [optional] | +| **email** | **String** | The email of the user. | [optional] | +| **name** | **String** | The name of the user. | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V2::UserUpdateAttributes.new( name: null ) ``` - diff --git a/docs/v2/UserUpdateData.md b/docs/v2/UserUpdateData.md index 2d30df12d1e8..e32792ff5c74 100644 --- a/docs/v2/UserUpdateData.md +++ b/docs/v2/UserUpdateData.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **attributes** | [**UserUpdateAttributes**](UserUpdateAttributes.md) | | | -| **id** | **String** | ID of the user. | | -| **type** | [**UsersType**](UsersType.md) | | [default to 'users'] | +| Name | Type | Description | Notes | +| -------------- | --------------------------------------------------- | --------------- | ---------------------------- | +| **attributes** | [**UserUpdateAttributes**](UserUpdateAttributes.md) | | | +| **id** | **String** | ID of the user. | | +| **type** | [**UsersType**](UsersType.md) | | [default to 'users'] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V2::UserUpdateData.new( type: null ) ``` - diff --git a/docs/v2/UserUpdateRequest.md b/docs/v2/UserUpdateRequest.md index c29233bc9873..f72bf0a885db 100644 --- a/docs/v2/UserUpdateRequest.md +++ b/docs/v2/UserUpdateRequest.md @@ -2,9 +2,9 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**UserUpdateData**](UserUpdateData.md) | | | +| Name | Type | Description | Notes | +| -------- | --------------------------------------- | ----------- | ----- | +| **data** | [**UserUpdateData**](UserUpdateData.md) | | | ## Example @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V2::UserUpdateRequest.new( data: null ) ``` - diff --git a/docs/v2/UsersAPI.md b/docs/v2/UsersAPI.md index 1e7574a633d9..f0bc40842018 100644 --- a/docs/v2/UsersAPI.md +++ b/docs/v2/UsersAPI.md @@ -2,19 +2,18 @@ All URIs are relative to *https://api.datadoghq.com* -| Method | HTTP request | Description | -| ------ | ------------ | ----------- | -| [**create_service_account**](UsersAPI.md#create_service_account) | **POST** /api/v2/service_accounts | Create a service account | -| [**create_user**](UsersAPI.md#create_user) | **POST** /api/v2/users | Create a user | -| [**disable_user**](UsersAPI.md#disable_user) | **DELETE** /api/v2/users/{user_id} | Disable a user | -| [**get_invitation**](UsersAPI.md#get_invitation) | **GET** /api/v2/user_invitations/{user_invitation_uuid} | Get a user invitation | -| [**get_user**](UsersAPI.md#get_user) | **GET** /api/v2/users/{user_id} | Get user details | -| [**list_user_organizations**](UsersAPI.md#list_user_organizations) | **GET** /api/v2/users/{user_id}/orgs | Get a user organization | -| [**list_user_permissions**](UsersAPI.md#list_user_permissions) | **GET** /api/v2/users/{user_id}/permissions | Get a user permissions | -| [**list_users**](UsersAPI.md#list_users) | **GET** /api/v2/users | List all users | -| [**send_invitations**](UsersAPI.md#send_invitations) | **POST** /api/v2/user_invitations | Send invitation emails | -| [**update_user**](UsersAPI.md#update_user) | **PATCH** /api/v2/users/{user_id} | Update a user | - +| Method | HTTP request | Description | +| ------------------------------------------------------------------ | ------------------------------------------------------- | ------------------------ | +| [**create_service_account**](UsersAPI.md#create_service_account) | **POST** /api/v2/service_accounts | Create a service account | +| [**create_user**](UsersAPI.md#create_user) | **POST** /api/v2/users | Create a user | +| [**disable_user**](UsersAPI.md#disable_user) | **DELETE** /api/v2/users/{user_id} | Disable a user | +| [**get_invitation**](UsersAPI.md#get_invitation) | **GET** /api/v2/user_invitations/{user_invitation_uuid} | Get a user invitation | +| [**get_user**](UsersAPI.md#get_user) | **GET** /api/v2/users/{user_id} | Get user details | +| [**list_user_organizations**](UsersAPI.md#list_user_organizations) | **GET** /api/v2/users/{user_id}/orgs | Get a user organization | +| [**list_user_permissions**](UsersAPI.md#list_user_permissions) | **GET** /api/v2/users/{user_id}/permissions | Get a user permissions | +| [**list_users**](UsersAPI.md#list_users) | **GET** /api/v2/users | List all users | +| [**send_invitations**](UsersAPI.md#send_invitations) | **POST** /api/v2/user_invitations | Send invitation emails | +| [**update_user**](UsersAPI.md#update_user) | **PATCH** /api/v2/users/{user_id} | Update a user | ## create_service_account @@ -27,7 +26,7 @@ Create a service account for your organization. ```ruby require 'datadog_api_client' api_instance = DatadogAPIClient::V2::UsersAPI.new -body = DatadogAPIClient::V2::ServiceAccountCreateRequest.new({data: DatadogAPIClient::V2::ServiceAccountCreateData.new({attributes: DatadogAPIClient::V2::ServiceAccountCreateAttributes.new({email: 'jane.doe@example.com', service_account: true}), type: DatadogAPIClient::V2::UsersType::USERS})}) # ServiceAccountCreateRequest | +body = DatadogAPIClient::V2::ServiceAccountCreateRequest.new({data: DatadogAPIClient::V2::ServiceAccountCreateData.new({attributes: DatadogAPIClient::V2::ServiceAccountCreateAttributes.new({email: 'jane.doe@example.com', service_account: true}), type: DatadogAPIClient::V2::UsersType::USERS})}) # ServiceAccountCreateRequest | begin # Create a service account @@ -58,9 +57,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**ServiceAccountCreateRequest**](ServiceAccountCreateRequest.md) | | | +| Name | Type | Description | Notes | +| -------- | ----------------------------------------------------------------- | ----------- | ----- | +| **body** | [**ServiceAccountCreateRequest**](ServiceAccountCreateRequest.md) | | | ### Return type @@ -75,7 +74,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## create_user > create_user(body) @@ -87,7 +85,7 @@ Create a user for your organization. ```ruby require 'datadog_api_client' api_instance = DatadogAPIClient::V2::UsersAPI.new -body = DatadogAPIClient::V2::UserCreateRequest.new({data: DatadogAPIClient::V2::UserCreateData.new({attributes: DatadogAPIClient::V2::UserCreateAttributes.new({email: 'jane.doe@example.com'}), type: DatadogAPIClient::V2::UsersType::USERS})}) # UserCreateRequest | +body = DatadogAPIClient::V2::UserCreateRequest.new({data: DatadogAPIClient::V2::UserCreateData.new({attributes: DatadogAPIClient::V2::UserCreateAttributes.new({email: 'jane.doe@example.com'}), type: DatadogAPIClient::V2::UsersType::USERS})}) # UserCreateRequest | begin # Create a user @@ -118,9 +116,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**UserCreateRequest**](UserCreateRequest.md) | | | +| Name | Type | Description | Notes | +| -------- | --------------------------------------------- | ----------- | ----- | +| **body** | [**UserCreateRequest**](UserCreateRequest.md) | | | ### Return type @@ -135,7 +133,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## disable_user > disable_user(user_id) @@ -178,9 +175,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **user_id** | **String** | The ID of the user. | | +| Name | Type | Description | Notes | +| ----------- | ---------- | ------------------- | ----- | +| **user_id** | **String** | The ID of the user. | | ### Return type @@ -195,7 +192,6 @@ nil (empty response body) - **Content-Type**: Not defined - **Accept**: application/json - ## get_invitation > get_invitation(user_invitation_uuid) @@ -238,9 +234,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **user_invitation_uuid** | **String** | The UUID of the user invitation. | | +| Name | Type | Description | Notes | +| ------------------------ | ---------- | -------------------------------- | ----- | +| **user_invitation_uuid** | **String** | The UUID of the user invitation. | | ### Return type @@ -255,7 +251,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## get_user > get_user(user_id) @@ -298,9 +293,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **user_id** | **String** | The ID of the user. | | +| Name | Type | Description | Notes | +| ----------- | ---------- | ------------------- | ----- | +| **user_id** | **String** | The ID of the user. | | ### Return type @@ -315,7 +310,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## list_user_organizations > list_user_organizations(user_id) @@ -359,9 +353,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **user_id** | **String** | The ID of the user. | | +| Name | Type | Description | Notes | +| ----------- | ---------- | ------------------- | ----- | +| **user_id** | **String** | The ID of the user. | | ### Return type @@ -376,7 +370,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## list_user_permissions > list_user_permissions(user_id) @@ -420,9 +413,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **user_id** | **String** | The ID of the user. | | +| Name | Type | Description | Notes | +| ----------- | ---------- | ------------------- | ----- | +| **user_id** | **String** | The ID of the user. | | ### Return type @@ -437,7 +430,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## list_users > list_users(opts) @@ -488,14 +480,14 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **page_size** | **Integer** | Size for a given page. | [optional][default to 10] | -| **page_number** | **Integer** | Specific page number to return. | [optional][default to 0] | -| **sort** | **String** | User attribute to order results by. Sort order is ascending by default. Sort order is descending if the field is prefixed by a negative sign, for example `sort=-name`. Options: `name`, `modified_at`, `user_count`. | [optional][default to 'name'] | -| **sort_dir** | **QuerySortOrder** | Direction of sort. Options: `asc`, `desc`. | [optional][default to 'desc'] | -| **filter** | **String** | Filter all users by the given string. Defaults to no filtering. | [optional] | -| **filter_status** | **String** | Filter on status attribute. Comma separated list, with possible values `Active`, `Pending`, and `Disabled`. Defaults to no filtering. | [optional] | +| Name | Type | Description | Notes | +| ----------------- | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------- | +| **page_size** | **Integer** | Size for a given page. | [optional][default to 10] | +| **page_number** | **Integer** | Specific page number to return. | [optional][default to 0] | +| **sort** | **String** | User attribute to order results by. Sort order is ascending by default. Sort order is descending if the field is prefixed by a negative sign, for example `sort=-name`. Options: `name`, `modified_at`, `user_count`. | [optional][default to 'name'] | +| **sort_dir** | **QuerySortOrder** | Direction of sort. Options: `asc`, `desc`. | [optional][default to 'desc'] | +| **filter** | **String** | Filter all users by the given string. Defaults to no filtering. | [optional] | +| **filter_status** | **String** | Filter on status attribute. Comma separated list, with possible values `Active`, `Pending`, and `Disabled`. Defaults to no filtering. | [optional] | ### Return type @@ -510,7 +502,6 @@ end - **Content-Type**: Not defined - **Accept**: application/json - ## send_invitations > send_invitations(body) @@ -522,7 +513,7 @@ Sends emails to one or more users inviting them to join the organization. ```ruby require 'datadog_api_client' api_instance = DatadogAPIClient::V2::UsersAPI.new -body = DatadogAPIClient::V2::UserInvitationsRequest.new({data: [DatadogAPIClient::V2::UserInvitationData.new({relationships: DatadogAPIClient::V2::UserInvitationRelationships.new({user: DatadogAPIClient::V2::RelationshipToUser.new({data: DatadogAPIClient::V2::RelationshipToUserData.new({id: '00000000-0000-0000-0000-000000000000', type: DatadogAPIClient::V2::UsersType::USERS})})}), type: DatadogAPIClient::V2::UserInvitationsType::USER_INVITATIONS})]}) # UserInvitationsRequest | +body = DatadogAPIClient::V2::UserInvitationsRequest.new({data: [DatadogAPIClient::V2::UserInvitationData.new({relationships: DatadogAPIClient::V2::UserInvitationRelationships.new({user: DatadogAPIClient::V2::RelationshipToUser.new({data: DatadogAPIClient::V2::RelationshipToUserData.new({id: '00000000-0000-0000-0000-000000000000', type: DatadogAPIClient::V2::UsersType::USERS})})}), type: DatadogAPIClient::V2::UserInvitationsType::USER_INVITATIONS})]}) # UserInvitationsRequest | begin # Send invitation emails @@ -553,9 +544,9 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **body** | [**UserInvitationsRequest**](UserInvitationsRequest.md) | | | +| Name | Type | Description | Notes | +| -------- | ------------------------------------------------------- | ----------- | ----- | +| **body** | [**UserInvitationsRequest**](UserInvitationsRequest.md) | | | ### Return type @@ -570,7 +561,6 @@ end - **Content-Type**: application/json - **Accept**: application/json - ## update_user > update_user(user_id, body) @@ -584,7 +574,7 @@ to an administrator user. require 'datadog_api_client' api_instance = DatadogAPIClient::V2::UsersAPI.new user_id = '00000000-0000-0000-0000-000000000000' # String | The ID of the user. -body = DatadogAPIClient::V2::UserUpdateRequest.new({data: DatadogAPIClient::V2::UserUpdateData.new({attributes: DatadogAPIClient::V2::UserUpdateAttributes.new, id: '00000000-0000-0000-0000-000000000000', type: DatadogAPIClient::V2::UsersType::USERS})}) # UserUpdateRequest | +body = DatadogAPIClient::V2::UserUpdateRequest.new({data: DatadogAPIClient::V2::UserUpdateData.new({attributes: DatadogAPIClient::V2::UserUpdateAttributes.new, id: '00000000-0000-0000-0000-000000000000', type: DatadogAPIClient::V2::UsersType::USERS})}) # UserUpdateRequest | begin # Update a user @@ -615,10 +605,10 @@ end ### Parameters -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **user_id** | **String** | The ID of the user. | | -| **body** | [**UserUpdateRequest**](UserUpdateRequest.md) | | | +| Name | Type | Description | Notes | +| ----------- | --------------------------------------------- | ------------------- | ----- | +| **user_id** | **String** | The ID of the user. | | +| **body** | [**UserUpdateRequest**](UserUpdateRequest.md) | | | ### Return type @@ -632,4 +622,3 @@ end - **Content-Type**: application/json - **Accept**: application/json - diff --git a/docs/v2/UsersResponse.md b/docs/v2/UsersResponse.md index f128bcb2ed4b..eefef2e67fa9 100644 --- a/docs/v2/UsersResponse.md +++ b/docs/v2/UsersResponse.md @@ -2,11 +2,11 @@ ## Properties -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **data** | [**Array<User>**](User.md) | Array of returned users. | [optional] | +| Name | Type | Description | Notes | +| ------------ | ------------------------------------------------------------------------ | -------------------------------------- | ---------- | +| **data** | [**Array<User>**](User.md) | Array of returned users. | [optional] | | **included** | [**Array<UserResponseIncludedItem>**](UserResponseIncludedItem.md) | Array of objects related to the users. | [optional] | -| **meta** | [**ResponseMetaAttributes**](ResponseMetaAttributes.md) | | [optional] | +| **meta** | [**ResponseMetaAttributes**](ResponseMetaAttributes.md) | | [optional] | ## Example @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V2::UsersResponse.new( meta: null ) ``` - diff --git a/docs/v2/UsersType.md b/docs/v2/UsersType.md index cc5b801fed14..c00a14c48f8b 100644 --- a/docs/v2/UsersType.md +++ b/docs/v2/UsersType.md @@ -12,4 +12,3 @@ require 'datadog_api_client/v2' instance = DatadogAPIClient::V2::UsersType.new() ``` - diff --git a/lib/datadog_api_client/v1/models/dashboard.rb b/lib/datadog_api_client/v1/models/dashboard.rb index 79d5949e6baa..ab7346a2021d 100644 --- a/lib/datadog_api_client/v1/models/dashboard.rb +++ b/lib/datadog_api_client/v1/models/dashboard.rb @@ -34,7 +34,7 @@ class Dashboard # ID of the dashboard. attr_accessor :id - # Whether this dashboard is read-only. If True, only the author and admins can make changes to it. + # Whether this dashboard is read-only. If True, only the author and admins can make changes to it. Prefer using `restricted_roles` to manage write authorization. attr_accessor :is_read_only attr_accessor :layout_type @@ -47,7 +47,7 @@ class Dashboard attr_accessor :reflow_type - # A list of role identifiers. Only the author and users associated with at least one of these roles can edit this dashboard. Overrides the `is_read_only` property if both are present. **This feature is currently in beta.** + # A list of role identifiers. Only the author and users associated with at least one of these roles can edit this dashboard. attr_accessor :restricted_roles # Array of template variables saved views.